This section explains what a user exit is and how to select and define one in NaturalONE. The following topics are covered:

• Introduction

• Define a User Exit

---

Introduction

By default, the generated source code is protected from editing and changes can only be made within user exits, positions within the generated code where you can insert customized or specialized processing. Changes to the user exit code are always preserved upon subsequent regeneration of the module. We recommend that you only add custom code within user exits.

The code generation wizards provide a wide variety of user exits, which vary based on the type of module you are generating. Some exits contain sample code or subprograms, while others generate the **SAG DEFINE EXIT and **SAG END-EXIT tags only — you provide the actual code. You can modify any user exit code generated into the edit buffer.

Notes:

1. For information on the supplied user exits, refer to User Exits for the Generation Models, Natural Construct Generation.
2. For information about the User Exit editor, refer to User Exit Editor, Natural Construct Generation.
3. If you require code to be inserted in the generated module where no user exit currently exists, have your Natural Construct administrator recommend a suitable exit or add a new exit to the wizard.

Define a User Exit

When a generated module is open in the Eclipse editor, all available user exits for the module are displayed in the Outline view. This section covers the following topics:

• Access a User Exit

• Add Code to a User Exit

• Generate Sample

• Clear Exit

• Modify Code in a User Exit

Access a User Exit

To access a user exit

1. Select the user exit in the Outline view.

2. Open the context menu for the user exit.

   For example:

   

3. Select one of the options listed.

   The user exit is displayed in the editor view. For example:

   

   The **SAG EXIT POINT tag indicates that the exit does not exist and you must use the Outline view to add code or generate sample code.

Add Code to a User Exit

To add code to a user exit

1. Open the context menu for the user exit.

2. Select Add Code.

   The exit is displayed in the editor view. For example:

   

   The **SAG DEFINE EXIT and **SAG END-EXIT tags indicate that the user exit exists, even when there is currently no code in it, and you can define or modify the exit directly in the editor.

3. Move the cursor to the end of the **SAG DEFINE EXIT user-exit-name line.

4. Select Enter.

5. Add the code on the lines provided.

Generate Sample

To add code to a user exit

1. Open the context menu for the user exit.

2. Select Generate Sample.

   The **SAG DEFINE EXIT and **SAG END-EXIT lines are displayed with sample code. For example:

   

3. Move the cursor to the end of the **SAG DEFINE EXIT user-exit-name line.

4. Modify the sample code as required.

Clear Exit

To clear code from an existing user exit

1. Open the context menu for the user exit in the Outline view.

2. Select Clear Exit.

   All lines of code within the selected exit are deleted and the comment line that identifies the insertion point for the exit within the editor is restored.

Modify Code in a User Exit

To modify code in a user exit

1. Select the user exit in the Outline view.

   The user exit is displayed in the editor.

2. Modify and save the user exit.