Skip to content

Commit

Permalink
Fix spelling etc for User Exits doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@mbtools
mbtools authored Sep 6, 2023
1 parent 2012f37 commit 2f8a135
Showing 1 changed file with 18 additions and 23 deletions.
41 changes: 18 additions & 23 deletions src/user-guide/reference/exits.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ If the development version is installed create global class `ZCL_ABAPGIT_USER_EX

To support both versions with the same code, proceed as follows:

1. Implement `ZCL_ABAPGIT_USER_EXIT` as global class and test with the developer version.
2. Cut & paste complete code of `ZCL_ABAPGIT_USER_EXIT` into include `ZABAPGIT_USER_EXIT` and change the beginning to a local class.
1. Implement `ZCL_ABAPGIT_USER_EXIT` as a global class and test with the developer version.
2. Cut & paste the complete code of `ZCL_ABAPGIT_USER_EXIT` into include `ZABAPGIT_USER_EXIT` and change the beginning to a local class.

```abap
CLASS zcl_abapgit_user_exit DEFINITION
Expand All @@ -25,7 +25,7 @@ CLASS zcl_abapgit_user_exit DEFINITION

3. Activate the include.

In either cases, add the object in a package different from the main abapGit code.
In either case, add the object in a package different from the main abapGit code.

The list of user exits can change at any time, make sure to syntax check user exits after updating abapGit.

Expand All @@ -43,16 +43,15 @@ Can be used to set the URL to display a commit. There are default implementation

### ADJUST_DISPLAY_FILENAME

This exit can be used to change the path and filename displayed in the repository view (see [#5185](https://github.com/abapGit/abapGit/issues/5185)). For example, you can implement a logic to shorten the path avoiding output of repetetive details.
This exit can be used to change the path and filename displayed in the repository view (see [#5185](https://github.com/abapGit/abapGit/issues/5185)). For example, you can implement a logic to shorten the path avoiding the output of repetitive details.

### ALLOW_SAP_OBJECTS

Force allowing serialization of SAP objects.

### CHANGE_LOCAL_HOST

If the hostnames are not properly configured, this exit can be used to modify the settings.
This is especially useful when running abapGitServer on the local system.
If the hostnames are not properly configured, this exit can be used to modify the settings. This is especially useful when running abapGitServer on the local system.

### CHANGE_PROXY_AUTHENTICATION

Expand All @@ -68,7 +67,7 @@ Determine the proxy URL from the repository URL.

### CHANGE_SUPPORTED_DATA_OBJECTS

Add or remove supported data objects. You can add single tables, for example `TABU,RSADMIN`, or a set of tables, for example `TABU,T009*`.
Add or remove supported data objects. You can add single tables, for example, `TABU, RSADMIN`, or a set of tables, for example `TABU, T009*`.

### CHANGE_SUPPORTED_OBJECT_TYPES

Expand All @@ -84,69 +83,65 @@ Store username and password in RFC connection setup (see [#1841](https://github.

### CUSTOM_SERIALIZE_ABAP_CLIF

Allows for a custom serializer to be used for global classes' CLIF sources. See [#2321](https://github.com/abapGit/abapGit/issues/2321) and [#2491](https://github.com/abapGit/abapGit/pull/2491) for use cases.
This [example implementation](https://gist.github.com/fabianlupa/999c8165b89131608b05cd371529fef5) forces the old class serializer to be used for specific packages.
Allows for a custom serializer to be used for global classes' CLIF sources. See [#2321](https://github.com/abapGit/abapGit/issues/2321) and [#2491](https://github.com/abapGit/abapGit/pull/2491) for use cases. This [example implementation](https://gist.github.com/fabianlupa/999c8165b89131608b05cd371529fef5) forces the old class serializer to be used for specific packages.

As of [#4953](https://github.com/abapGit/abapGit/pull/4953), the exit offers a post-processing option. First, the exit is called with the optional parameter
`it_source` set to initial. If you do not return any serialization (`rt_source` is initial), then abapGit will serialize the object as usual and call the
exit a second time. This time `it_source` contains the complete source and can be modified in the exit as required. To use this option, use following code
at the beginning of the exit:
As of [#4953](https://github.com/abapGit/abapGit/pull/4953), the exit offers a post-processing option. First, the exit is called with the optional parameter `it_source` set to initial. If you do not return any serialization (`rt_source` is initial), then abapGit will serialize the object as usual and call the exit a second time. This time `it_source` contains the complete source and can be modified in the exit as required. To use this option, use the following code at the beginning of the exit:

```abap
" Ignore first call of exit
" Ignore the first call of exit
IF it_source IS INITIAL.
RETURN.
ENDIF.
```

### DESERIALIZE_POSTPROCESS

Can be used for any postprocessing operation for deserialized objects. Since it is a postprocessing step, only logs can be added to II_LOG and one should not terminate the process by raising exception, which may lead to inconsistencies.
Can be used for any postprocessing operation for deserialized objects. Since it is a postprocessing step, only logs can be added to `ii_log` and one should not terminate the process by raising an exception, which may lead to inconsistencies.

### DETERMINE_TRANSPORT_REQUEST

Set a transport request per repository. If set, no transport request popup appears and the transport is used for pull/delete (see [#5916](https://github.com/abapGit/abapGit/pull/5916)).

### ENHANCE_REPO_TOOLBAR

With this exit you can extend the toolbar with your own menu options. Currently, the exit is active for repository settings so you may define your own settings (see [#6249](https://github.com/abapGit/abapGit/pull/6249)).
With this exit, you can extend the toolbar with your own menu options. Currently, the exit is active for repository settings so you may define your own settings (see [#6249](https://github.com/abapGit/abapGit/pull/6249)).

### GET_CI_TESTS

Add your own repositories to run a complete CI cycle (clone, pull, check, delete) when executing unit tests for object serializer classes (see [#3993](https://github.com/abapGit/abapGit/pull/3993)).

### GET_SSL_ID

Possibility to change the default `ANONYM` SSL ID to something system specific.
Possibility to change the default `ANONYM` SSL ID to something system-specific.

### HTTP_CLIENT

Can be used for setting logon tickets eg. in connection with abapGitServer connections between SAP systems ([Example](https://gist.github.com/larshp/71609852a79aa1e877f8c4020d18feac)).
Can be used for setting login tickets eg. in connection with abapGitServer connections between SAP systems ([Example](https://gist.github.com/larshp/71609852a79aa1e877f8c4020d18feac)).

### ON_EVENT

This exit allows you to extend abapGit with new features that are not suitable for abapGit itself. For example, you can link to a new page from a wall message. Another use case is redirecting menu items to a custom page rather than standard abapGit, for example using a company-specific solution to replace "Advanced > Run Code Inspector" (see [#4722](https://github.com/abapGit/abapGit/issues/4722)).

### PRE_CALCULATE_REPO_STATUS

Can be used to modify local and remote files before calculating diff status. Useful to remove diffs which are caused by deployment between different system version (see also [abapgit xml stripper plugin](https://github.com/sbcgua/abapgit_xml_stripper_plugin)).
Can be used to modify local and remote files before calculating diff status. Useful to remove diffs that are caused by deployment between different system versions (see also [abapgit xml stripper plugin](https://github.com/sbcgua/abapgit_xml_stripper_plugin)).

![diff sample](/img/deployment_diff_difference_sample.png)

The exit also receives a repo meta data snapshot (`zif_abapgit_persistence=>ty_repo`) to identify the repo and it's attributes in the current system (e.g. package). This can be used to enable/disable the exit for specific repos.
The exit also receives a repo metadata snapshot (`zif_abapgit_persistence=>ty_repo`) to identify the repo and its attributes in the current system (e.g. package). This can be used to enable/disable the exit for specific repos.

### SERIALIZE_POSTPROCESSING

This exit is called at the end of the serialize process and gives an opportunity to change the content of the serialzed files (see [#5194](https://github.com/abapGit/abapGit/issues/5194)).
This exit is called at the end of the serialize process and gives an opportunity to change the content of the serialized files (see [#5194](https://github.com/abapGit/abapGit/issues/5194)).

### VALIDATE_BEFORE_PUSH

Perform custom validations just before pushing into remote while being on the "Commit Message" screen (see [#6013](https://github.com/abapGit/abapGit/pull/6013)).

### WALL_MESSAGE_LIST

Can be used to add a message at list level (repository list, see [#4653](https://github.com/abapGit/abapGit/issues/4653)).
Can be used to add a message at the list level (repository list, see [#4653](https://github.com/abapGit/abapGit/issues/4653)).

### WALL_MESSAGE_REPO

Can be used to add a message at repo level (repository view, see [#4653](https://github.com/abapGit/abapGit/issues/4653)).
Can be used to add a message at the repo level (repository view, see [#4653](https://github.com/abapGit/abapGit/issues/4653)).

0 comments on commit 2f8a135

Please sign in to comment.