Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history
commit 15260c42b1d55528a975df2ee24ddfeb3d49a28d
Author: REDACTED
Date:   Thu Aug 15 15:55:27 2024 +0000

    Update from SAP DITA CMS 2024-08-15 15:55:27
    Project: dita-all/dkl1587758022827
    Project map: bf20decceb934e9492c420e6138a2410.ditamap
    Output: loio042b51923fc64122ac4c1627fb4b42c2
    Language: en-US
    Builddable map: 65817585a1874e8296d5ee9b43edb30f.ditamap

commit 0cb474b583b378d55418a5c985ef4670136d8833
Author: REDACTED
Date:   Thu Aug 15 11:51:34 2024 +0000

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

commit 85434754d5e755fbe6fdfa4f40dc398ab2a5bca7
Author: REDACTED
Date:   Wed Aug 14 15:25:40 2024 +0000

    Update from SAP DITA CMS 2024-08-14 15:25:40
    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 Aug 19, 2024
1 parent 5212b8f commit e0ef490
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

# Define Application Structure

Being part of the SAP Fiori Tools – Application Modeler extension, SAP Fiori tools *Page Map* allows to change the pages structure of the application and application-wide settings like the *Flexible Column Layout*.
Being part of the SAP Fiori Tools – Application Modeler extension, SAP Fiori tools *Page Map* allows to change the pages structure of the application and application-wide settings like the *Flexible Column Layout* that's available when using SAP Fiori elements.

> ### Tip:
> Page Map also supports SAPUI5 freestyle applications. However, this is an experimental feature with a limited scope. For example, you currently can't add and delete pages.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -836,7 +836,7 @@ Open the page map that shows application pages and navigation paths.
</td>
<td valign="top">


![](images/Checkmark_Good_8eb8536.png)

</td>
<td valign="top">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In SAP Business Application Studio, you can create additional run configurations
4. Fill in the following sections:

- *Name* \(**mandatory**\) - You can change the name.
- *File Name*\(**mandatory**\) - Select htm file that is used when application is started.
- *Endpoint*\(**mandatory**\) - Select htm file that is used when application is started.
- *Mock Data* - Runs your application with a mock server which will mock the OData requests.
- *Support Assistant* - Enables application developers to check whether their applications are built according to the best practices for building SAPUI5 applications. The tool uses a set of pre-defined rules to check all aspects of an application.
- *URL Components* - Enables application developer to define additional URL parameters and/or hash fragment for the SAP Fiori launchpad intent-based navigation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A new run configuration is created with the command `Fiori: Open Run Configurati
4. Fill in the following sections:

- *Name* \(**mandatory**\) - You can change the name.
- *File Name*\(**mandatory**\) - Select html file that is used when application is started.
- *Endpoint*\(**mandatory**\) - Select html file that is used when application is started.
- *Mock Data* - Runs your application with a mock server which will mock the OData requests.
- *Support Assistant* - Enables application developers to check whether their applications are built according to the best practices for building SAPUI5 applications. The tool uses a set of pre-defined rules to check all aspects of an application.
- *URL Components* - Enables application developer to define additional URL parameters and/or hash fragment for the SAP Fiori launchpad intent-based navigation.
Expand Down
24 changes: 12 additions & 12 deletions docs/Project-Functions/data-editor-18e43b5.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@

# Data Editor

Previewing the application using `npm run start-mock` generates mock data on the fly. If you want to generate mock data and store it in the `.json` file format, you can right-click on your project and launch `Open Data Editor`. Once generated, mock data is stored in the `.json` format under the `/webapp/localService/mockdata` file.
Previewing the application using `npm run start-mock` generates mock data on the fly. If you want to generate mock data and store it in the `.json` file format, you can right-click on your project and launch *Open Data Editor*. Once generated, mock data is stored in the `.json` format under the `/webapp/localService/mockdata` file.

> ### Note:
> You need to configure mock server prior to using `npm run start-mock`. See [Installing MockServer](../Previewing-an-Application/installing-mockserver-2538055.md).
For templates like *Overview page* where there are multiple services, you will see a drop-down list to select the metadata file you want use. If your application is running, you can stop the mock server by pressing [Ctrl\] + [C\] .
For templates like the *Overview Page* where there are multiple services, you will see a drop-down list to select the metadata file you want to use. If your application is running, you can stop the mock server by pressing [Ctrl\] + [C\] .

![](images/Fiori_Tools_Show_Properties_in_Data_Editor_15deef9.png)

Data Editor reads the `metadata.xml` file that is defined in the `manifest.json` under the `dataSource` and generates mock data based on the property type.

Data can be edited by either double-clicking in the cell of the Data Editor or by editing the `Entity.json` file.

![Manifest.json](images/DataEditor_Manifest_file_0c29c6d.png)
![manifest.json](images/DataEditor_Manifest_file_0c29c6d.png)

If the **mock server isn’t running**, you can:
If the mock server isn’t running, you can:

- Make changes in the Data Editor, automatically reflected in the `.json` file.

- If changes are made in the `.json` file, hit the *Refresh* button to update the canvas.
- If changes are made in the `.json` file, click the *Refresh* button to update the canvas.


If the mock server is running:

- Add the `watch: true` parameter to the `ui5-mock.yaml` file in order to pick up the changes.
- Add the `watch: true` parameter to the `ui5-mock.yaml` to update the canvas.

![ui5-mock.yaml](images/Data_Editor_ui5mockyaml_3e50d51.png)

Expand All @@ -37,17 +37,17 @@ If the mock server is running:

## Editing Mock Data

**Editing Data**- **double-click** in the editable cell.
**Editing Data**- edit data by double-clicking in the editable cell.

> ### Note:
> Primary keys and foreign keys aren’t editable.
**Add Row** - add one row at a time to your data by pressing the *Add Row* button.
**Add Row** - add a row by clicking the *Add Row* button.

> ### Note:
> Additional rows will be added automatically to all the entities that are associated with a foreign key.
**Delete Row** - select any row or rows and press the *Delete Row* button.
**Delete Row** - delete a row by selecting a row and clicking the *Delete Row* button.

> ### Note:
> Rows will be automatically deleted on all the entities that are associated with a foreign key.
Expand All @@ -60,9 +60,9 @@ If the mock server is running:

To search for mock data, perform the following steps:

1. Click on the *Search* input field in the header bar of the Data Editord.
1. Click on the *Search* input field in the header bar of the Data Editor.
2. Enter search criteria in the search input field.
3. Select the mock data that matches the search criteria in the drop-down table. The data selected is highlighted in the Data Editor table.
3. Select the mock data that matches the search criteria in the drop-down table. The data you selected is highlighted in the Data Editor table.



Expand All @@ -89,5 +89,5 @@ To hide properties in the Data Editor table, perform the following steps:


> ### Note:
> Certain property groups are hidden by default and can be shown using the *Show Properties* functionality. You can also search for a particular property using the search input field in the popup.
> Certain property groups are hidden by default and can be shown using *Show Properties*. You can also search for a particular property using the search input field in the popup.
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,18 @@

# Deleting an Application in CAP Project

> ### Note:
> For more information about CAP services, see: [https://cap.cloud.sap/docs/about/](https://cap.cloud.sap/docs/about/).
You can safely delete an SAP Fiori application created inside CAP projects with the SAP Fiori elements or freestyle SAPUI5 generators. The deletion process will delete the folder containing the application along with all changes in global files, such as references to already invalid annotations in a subfolder.

> ### Tip:
> For more information about CAP projects, see [https://cap.cloud.sap/docs/about/](https://cap.cloud.sap/docs/about/).
Perform the following steps:

1. By using **Command Palette** in VS Code \([CMD\]/[CTRL\] + [Shift\] + [P\]\), execute the *Fiori: Delete Application from CAP project* command.
2. Select the application you want to delete from the dropdown list of applications available.
3. A dialog box *Do you really want to delete application <application\_name\>?* with the following options appears:
1. Open the Command Palette in VS Code \([CMD\]/[CTRL\] + [Shift\] + [P\]\) and execute the *Fiori: Delete Application from CAP project* command.
2. Select the application you want to delete from the dropdown list of applications available. A dialog box *Do you really want to delete application <application\_name\>?* with the following options appears:
- *Yes*
- *No*
- *Cancel*

4. Click *Yes* to delete the required application and revert all changes in global files.

> ### Note:
> If you select either *No* or *Cancel*, the application will remain the same without any changes applied.
3. Click *Yes* to delete the application and revert all changes in global files.

34 changes: 18 additions & 16 deletions docs/Project-Functions/environment-check-75390cf.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,34 @@

## Destination Checks: SAP Business Application Studio

SAP Fiori tools environment check creates a report that the users can use to identify and change the issues. In addition, the report also contains information that can be very useful for SAP Product Support to gather the initial set of information to further process an incident. Please note that SAP Fiori tools environment check is a tool to help troubleshoot some common destination-related issues. To use SAP Fiori tools environment check:
SAP Fiori tools environment check creates a report that you can use to troubleshoot common destination-related issues.

1. In SAP Business Application Studio, execute the command `Fiori: Open Environment Check` and choose `Check destination`.
2. Choose a `destination` from the quick pick.
3. If prompted, enter credentials.
4. To view the results, choose *View the results*.
5. To create a zip file to be shared with SAP Product Support, choose *View and Save results*.
To use SAP Fiori tools environment check, perform the following steps:

The environment check report for SAP Fiori tools has the following sections:
1. In SAP Business Application Studio, execute the command `Fiori: Open Environment Check` and click *Create destination*.
2. Select a destination from the dropdown.
3. If prompted, enter your credentials.
4. To view the results, click *View the results*.
5. To view the results and save them to a ZIP file that you can send to SAP Product Support, click *View and Save results*.

- **Environment**: It displays all the important details like Dev Space type, node version, and other information about the environment.
- **Destination Details**: It displays chosen destination-specific information like destination parameters. It may also contain some messages specific to SAP Fiori tools usage.
- **All Destination Details**: This section lists all the destinations and their properties available to the user in the current subaccount.
- **Messages**: This section has raw log messages of chosen destination which can be useful for SAP Product Support.
The SAP Fiori tools environment check report has the following sections:

- **Environment** provides the Dev Space type, Node version, and other information about the environment.
- **Destination Details** provides destination parameters and other information about the destination.
- **All Destination Details** lists all the destinations and their properties available to the user in the current subaccount.
- **Messages** provides raw log messages of the chosen destination which can be useful for SAP Product Support.



<a name="loio75390cf5d81e43aea5db231ef4225268__section_nkk_cvy_dvb"/>

## Gather Environment Information: SAP Business Application and VSCode

SAP Fiori tools environment check can also check and create report on the development environment in SAP Business Application Studio or VS Code. This information will be very useful to add to a support ticket so that SAP Product Support has relevant information about your development environment to start with. For example, you can have an older version of SAP Fiori application generator or some required `npm` package can be missing.
SAP Fiori tools environment check can also check and create reports on the development environment in SAP Business Application Studio or VS Code. This report provides the SAP Fiori application generator version, a list of `npm` packages, and other information about your development environment.

To get the environment information, follow the steps:
To gather environment information, perform the following steps:

1. In SAP Business Application Studio or VS Code, execute the command `Fiori: Open Environment Check` and choose `Gather environment information`.
2. To see the results immediately, choose *View and Copy results*. The environment check details will also be copied to your clipboard for easy access.
3. To see the results and create a zip file to be shared with SAP Product Support, choose *View and Save results*. You see a report that has details, such as tools and `npm` packages installed along with the version numbers.
1. In SAP Business Application Studio or VS Code, execute the command `Fiori: Open Environment Check` and click `Gather environment information`.
2. To view the results, click *View and Copy results*. The environment check details will be copied to your clipboard for easy access.
3. To view the results and save them to a ZIP file that you can send to SAP Product Support, click *View and Save results*.

2 changes: 1 addition & 1 deletion docs/Project-Functions/information-panel-a9a6c4b.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Information Panel

Version 1.11.4 of SAP Fiori tools introduces an information panel that gives you access to the release note, useful links to learn about SAP Fiori elements developments, links to tutorials, and information about how to get support as a customer.
Version 1.11.4 of SAP Fiori tools introduces an information panel that gives you access to the release notes, useful links to learn about SAP Fiori elements developments, links to tutorials, and information about how to get support as a customer.

**How to access the information panel**

Expand Down
43 changes: 18 additions & 25 deletions docs/Project-Functions/managing-system-connection-78a82b6.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

# Managing System Connection

SAP Fiori tools running in VS Code enables to save the connection information to a remote system. This functionality provides faster authentication while creating an application, generating deployment configuration, and deploying an application. The credentials are saved in the operating system secured storage, such as Credential Manager in Windows and Keychain in Mac.
SAP Fiori tools running in VS Code allows you to save the connection information for a remote system. This functionality provides faster authentication when creating an application, generating a deployment configuration, and deploying an application. The credentials are saved in the operating system secured storage, such as Credential Manager in Windows and Keychain in Mac.



<a name="loio78a82b6852ce4061ba0825afdb79cda6__section_jv1_xgh_3qb"/>

## View Saved Systems Details
## View SAP System Details

To view the saved systems details, perform the following steps:
To view the details of an existing SAP system, perform the following steps:

1. On the activity toolbar from the left side, click *SAP Fiori* \(![Wrench/Pencil icon](images/SAP_Fiori_tools_Wrench_Pencil_9d6b0f8.png)\).
2. Expand the *SAP Systems* view.
Expand All @@ -28,9 +28,9 @@ To view the saved systems details, perform the following steps:

<a name="loio78a82b6852ce4061ba0825afdb79cda6__section_mrq_tbr_2rb"/>

## Test Saved Systems Connection
## Test SAP System Connection

To view the saved systems details, perform the following steps:
To test the connection of an existing SAP system, perform the following steps:

1. Open the details of a saved system. For more information, see [View Saved Systems Details](managing-system-connection-78a82b6.md#loio78a82b6852ce4061ba0825afdb79cda6__section_jv1_xgh_3qb).
2. Click *Test Connection*.
Expand All @@ -45,11 +45,11 @@ To view the saved systems details, perform the following steps:

<a name="loio78a82b6852ce4061ba0825afdb79cda6__section_v2b_wpy_lqb"/>

## Edit Saved Systems
## Edit SAP System Connection

For editing an existing SAP system connection detail, perform the following steps:
To edit the connection details for an existing SAP system, perform the following steps:

1. Right-click a saved system name and click the *Show SAP System Details* button or click a saved system name to open system details tab to open *SAP system Details*.
1. Right-click the saved system name you wish to edit and click the *Show SAP System Details* button.
2. For *ABAP On Premise*, update any of the following fields:
- System Name
- URL
Expand Down Expand Up @@ -77,36 +77,32 @@ For editing an existing SAP system connection detail, perform the following step


6. Click on *Test Connection*.

> ### Note:
> We recommend that you test the connection before saving to ensure it’s working as expected.
7. Click *Save*.



<a name="loio78a82b6852ce4061ba0825afdb79cda6__section_hr1_zhh_3qb"/>

## Delete Saved Systems
## Delete SAP System Connection

To delete the saved systems, perform the following steps:
To delete the connection to a SAP system, perform the following steps:

1. On the activity toolbar from the left side, click *SAP Fiori* \(![Wrench/Pencil icon](images/SAP_Fiori_tools_Wrench_Pencil_9d6b0f8.png)\).
2. Expand the *SAP Systems* view.
3. Select any saved system.
3. Select the saved system you wish to delete.
4. Click the :wastebasket: \(*Delete*\) icon next to the system name.
5. Click *Yes* in the confirmation dialogue box.



<a name="loio78a82b6852ce4061ba0825afdb79cda6__section_cn1_1lh_3qb"/>

## Create New System
## Create New SAP System

To create a new ABAP On Premise system, perform the following steps:

1. Click the [\+\] icon with the tooltip *Add SAP System* on the right side of the system panel.
2. Enter valid values for ABAP On Premise system that you have access to:
1. Click the :heavy_plus_sign: \(*Add*\) icon with the tooltip *Add SAP System* on the right side of the system panel.
2. Enter valid values for the ABAP On Premise system that you have access to:
- *System Name*: your choice
- *URL*: system URL
- *Client*: usually 3 digits, leave empty if not required
Expand All @@ -122,20 +118,17 @@ To create a new ABAP On Premise system, perform the following steps:



> ### Note:
> You can save the new system without first validating that the connection is successful. However, we recommend that you test the connection before saving to ensure it works as expected.
To create a new ABAP Environment on SAP BTP, perform the following steps:
To create a new ABAP Environment on SAP Business Technology Platform \(SAP BTP\), perform the following steps:

1. Click the [\+\] icon with the tooltip *Add SAP System* on the right side of the system panel.
1. Click the :heavy_plus_sign: \(*Add*\) icon icon with the tooltip *Add SAP System* on the right side of the system panel.

2. Under *System Type*, select *ABAP Environment on SAP Business Technology Platform*.

3. Under *Authentication Type*, select either *Service Key* or *Reentrance Ticket*.

**Service Key**

1. For authenticating with a Service Key, enter valid values for the ABAP Environment on SAP Business Technology Platform system that you have access to:
1. For authenticating with a Service Key, enter valid values for the ABAP Environment on SAP BTP system that you have access to:

- *System Name*: your choice

Expand Down Expand Up @@ -190,7 +183,7 @@ To create a new ABAP Environment on SAP BTP, perform the following steps:

To export an existing ABAP On Premise system, perform the following steps:

1. Right-click a saved system name and click *Show SAP System Details* or click a saved system name to open the *SAP Systems* details.
1. Right-click a saved system name and click *Show SAP System Details*.
2. Click *Export System*. A copy of the saved system will be downloaded in JSON format. Please note that no sensitive credential information is included in the exported JSON file.

To import an ABAP On Premise system, perform the following steps:
Expand Down

0 comments on commit e0ef490

Please sign in to comment.