Skip to content

Add docs for "Tools" menu #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/.vuepress/public/img/debug-info-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/debug-info-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/debug-info-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/debug-info-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/debug-info-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/ie-dev-tools-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/ie-dev-tools-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/objects-to-files-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.vuepress/public/img/package-to-zip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion src/user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,15 @@ index: false
- [Background Mode](repo-settings/background-mode.md)
- [Statistics](repo-settings/stats.md)

## Tools

- [Database Utility](tools/database-util.md)
- [Package to ZIP](tools/package-to-zip.md)
- [Transport to ZIP](tools/transport-to-zip.md)
- [Objects to Files](tools/objects-to-files.md)
- [Debug Info](tools/debug-info.md)
- [IE Dev Tools](tools/ie-dev-tools.md)

### Reference

- [Translations and I18n](reference/translations.md)
Expand All @@ -69,7 +78,6 @@ index: false
- [ABAP Language Version](reference/abap-language-version.md)
- [Note Analyzer](reference/note-analyzer.md)
- [APACK](reference/apack.md)
- [Database Utility](reference/database-util.md)

### Other

Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ order: 50
- [ABAP Language Version](abap-language-version.md)
- [Note Analyzer](note-analyzer.md)
- [APACK](apack.md)
- [Database Utility](database-util.md)

18 changes: 18 additions & 0 deletions src/user-guide/tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Tools
icon: tools
article: false
index: false
dir:
order: 45
---

## Tools

- [Database Utility](database-util.md)
- [Package to ZIP](package-to-zip.md)
- [Transport to ZIP](transport-to-zip.md)
- [Objects to Files](objects-to-files.md)
- [Debug Info](debug-info.md)
- [IE Dev Tools](ie-dev-tools.md)

4 changes: 2 additions & 2 deletions src/user-guide/reference/database-util.md → src/user-guide/tools/database-util.md
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Database Utility
category: reference
order: 99
category: tools
order: 10
---

`Database Utility` is a tool for managing database entries created by abapGit. You can access the tool via the tools icon in the top right corner of the abapGit home page [](/img/utilities.png).
Expand Down
33 changes: 33 additions & 0 deletions src/user-guide/tools/debug-info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Debug Info
category: tools
order: 50
---

The "Debug Info" page contains four sections:

### abapGit Version

Shows if this is the abapGit Developer or Standalone Version and in which package abapGit is installed:

![Developer Version](/img/debug-info-1.png)

![Standalone Version](/img/debug-info-2.png)

### Environment

Various version and timestamp details:

![Environment](/img/debug-info-3.png)

### User Exits

Shows a list of available user exits with implementation status:

![User Exits](/img/debug-info-4.png)

### Supported Objects

This section contains a list of all object types that are supported in the current system: object description, serializer class, serializer version, and deserializer steps that this object type uses.

![Supported Objects](/img/debug-info-5.png)
23 changes: 23 additions & 0 deletions src/user-guide/tools/ie-dev-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: IE Developer Tools
category: tools
order: 60
---

If you want to analyze the HTML pages generated by abapGit, use the IE Developer Tools.

### Prerequisites

- SAP GUI for Windows
- Internet Explorer Browser Control
- Local IE Developer Tools Installation

### Analysis

Go to the Repository Overview and select "Tools > Open IE Dev Tools" from the menu. On the following popup, pick the "abapGit" browser session.

![Start](/img/ie-dev-tools-1.png)

The following window will show the DOM Explorer and CSS properties:

![Check](/img/ie-dev-tools-2.png)
15 changes: 15 additions & 0 deletions src/user-guide/tools/objects-to-files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Objects to Files
category: tools
order: 40
---

Serialize one or several objects (of the same type) and save the files locally.

You will be prompted for the target folder for each selected object.

### Example

![Dialog](/img/objects-to-files-1.png)

![Result](/img/objects-to-files-2.png)
15 changes: 15 additions & 0 deletions src/user-guide/tools/package-to-zip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Package to ZIP
category: tools
order: 20
---

Export an SAP Package, optionally with sub-packages, to a ZIP file:

![Dialog](/img/package-to-zip.png)

The resulting ZIP will contain files for all serialized objects that were included in the selected package(s). The format allows you to use the ZIP to import the objects into another system using an offline repository.

:::info
The package does not have to be configured as a repository in abapGit.
:::
11 changes: 11 additions & 0 deletions src/user-guide/tools/transport-to-zip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Transport to ZIP
category: tools
order: 30
---

Export objects contained in a transport request to a ZIP file.

The resulting ZIP will contain files for objects that were included in the selected package(s).

Partial objects (LIMU) are resolved into the parent object (R3TR) they belong to.