Maintaining Destination Definitions

#### Search Results

Search

# Maintaining Destination Definitions

A destination definition defines the destination of audit data. Destination definitions can be created for Audit, webMethods EntireX (or, EntireX Broker), and Null destinations.

Destination Type | Description
--- | ---
Audit | Auditing Data is written to the ALOG file.
EntireX Broker | Auditing Data is written to an output queue via webMethods EntireX Broker.
Null | Auditing Data is tested without actually sending the data to a destination.

This section describes the following topics:

- Listing Destination Definitions

- Adding Audit Destination Definitions

- Adding EntireX Broker Destination Definitions

- Adding Null Destination Definitions

- Modifying Destination Definitions

- Copying Destination Definitions

- Deleting Destination Definitions

## Listing Destination Definitions

To use the Adabas Auditing Configuration to list the Destination definitions stored in the Auditing system file, complete the following steps:

- Select option D from the Adabas Auditing Configuration Main Menu.

  The Available Destinations screen appears showing all Destination definitions in the Adabas Auditing Configuration.

      17:35:57        ***** A D A B A S  AUDITING CONFIGURATION *****      2021-01-12
                                 Available Destinations                    M-RP1200

       Sel  Name                               ID       Type
       ---  --------------------------------   --------   ----
        _   PAYROLL_APPL._AUDIT_DESTINATION    PYRLDEST   AUDT

      Command ==>

      Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
            Help  Repos Exit  Add         ID     -     +                      Menu

The following tables describe the options on this menu.

Sel | Allows you to:
--- | ---
M | Modify a Destination definition
C | Copy a Destination definition
D | Delete a Destination definition
PF Key | Allows you to:
PF1 | Get screen help
PF2 | Reposition to a specific Destination definition in the list
PF3 | Exit this screen and return to the previous screen
PF4 | Add a new Destination definition
PF6 | Toggle between the sorting of Destination definition in the list
PF12 | Exit this screen and return to the main menu

## Adding Audit Destination Definitions

To use the Adabas Auditing Configuration to add a Destination definition to the Auditing system file, complete the following steps:

1. Select D from the Adabas Auditing Configuration main menu to list the Destination definitions, as described above in Listing Destination Definitions.

2. Press PF4 (Add).

   The Create New Destination screen appears.

       17:18:09        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                   Create New Destination                   M-RP1290

                              Code    Function
                              ----    -------------------------
                                A     Create Audit Destination
                                E     Create Broker Destination
                                N     Create Null Destination
                                ?     Help
                                .     Exit
                              ----    -------------------------
                      Code ...  _

       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit                                                  Menu

3. Select option A on the Create New Destination screen.

   The Audit Destination Definition screen appears.

       17:28:07        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                Audit Destination Definition                M-RP1250

       Destination Name ...... NAME_OF_DESTINATION_ID_AUDIT1
       Destination ID ........ AUDIT1__

       Active at Startup ..... Y
       Architecture .......... 2
       Open at Startup ....... G
       Maximum Output size ... _________0

       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit        Save                                      Menu

4. Update the fields on this screen as described in the following table.

   Field Name | Description | Default
   --- | --- | ---
   Destination Name | The name of the output destination. All destination definitions require a unique name. The name must use alphanumeric characters and be between 1 and 32 characters long. Embedded spaces are replaced automatically with underscores. | None
   Destination ID | The ID of the output destination. All destination definitions require a unique ID. The ID must use alphanumeric characters and be between 1 and 8 characters long. | None
   Active at Startup | Whether the destination should be activated at Audit Server startup. Valid values are “Y” (activate destination) or “N” (do not activate destination). | Y
   Architecture | Use this field to specify the data architecture for fields in the URB* control structures sent to the destination. To calculate a value for this parameter, add the value of the byte order element and the encoding element in the control structure:
       Control Structure Element  Values  Description
       Byte order (b)             0       High-order byte first
                                  1       Low-order byte first
       Encoding Family (e)        0       ASCII encoding family
                                  2       EBCDIC encoding family
   For example, the default value 2, indicates that the byte order element value is "0" and the encoding family value is "2". | 2
   Open at Startup | Whether or not the destination should be opened at Audit Server startup. Valid values are "Y", "N", or "G", with "G" (global value) as the default. When this parameter is set to "Y", the destination is opened at Audit Server startup. When this parameter is set to "N", the destination is not opened at Audit Server startup. | G
   Maximum Output size | The maximum output size (in bytes) for the destination. Valid values are 0 or an integer ranging from 4096 through 2,147,483,647. | 0

5. Press PF5 to save the Destination definition in the Auditing system file.

## Adding EntireX Broker Destination Definitions

To use the Adabas Auditing Configuration to add an EntireX Broker Destination definition to the Auditing system file, complete the following steps:

1. Select D from the Adabas Auditing Configuration main menu to list the Destination definitions, as described above in Listing Destination Definitions.

2. Press PF4 (Add).

   The Create New Destination screen appears.

       17:18:09        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                   Create New Destination                   M-RP1290

                              Code    Function
                              ----    -------------------------
                                A     Create Audit Destination
                                E     Create Broker Destination
                                N     Create Null Destination
                                ?     Help
                                .     Exit
                              ----    -------------------------
                      Code ...  _

       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit                                                  Menu

3. Select option E on the Create New Destination screen.

   The EntireX Broker Destination Definition screen appears.

       17:47:29        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                       EntireX Broker                       M-RP1220
                                   Destination Definition

       Destination Name ..... ETB_DESTINATION_________________
       Destination ID ....... AUDETB1_
       Active at Startup .... Y
       Architecture ......... 2
       Broker
        ID .................. UHO2135:SVC229:NET______________
        Service ............. SEXX____________________________
        Service Class ....... ETBSERV_________________________
        Service Name ........ AUD2____________________________
        Single Conversation   N
       Commit Threshold ..... _________5
       Maximum Output Size .. _________0
       Open at Startup ...... G             SLOG allowed ........ N
       Queue Full Delay ..... GLOBAL____
       Retry Open Count ..... GLOBAL____
       Retry Open Interval .. GLOBAL____
       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit        Save                                      Menu

4. Update the following general fields on the EntireX Broker Destination Definition screen as described in the following table.

   Field Name | Description | Default
   --- | --- | ---
   Active at Startup | Whether or not this destination definition should be activated for use once it is loaded by the Auditing Server. Valid values are “Y” (load and activate definition) or “N” (load, but do not activate definition). | Y
   Architecture | The data architecture for fields in the URB* control structures sent to the EntireX Broker destination. To calculate a value for this parameter, add the value of the byte order element and the encoding element in the control structure:
       Control Structure Element  Values  Description
       Byte order (b)             0       High-order byte first
                                  1       Low-order byte first
       Encoding Family (e)        0       ASCII encoding family
                                  2       EBCDIC encoding family
   For example, the default value 2, indicates that the byte order element value is "0" and the encoding family value is "2". | 2
   Broker ID | The EntireX Broker ID for which this destination definition applies. The name can be up to 32 characters long. Broker IDs come in two formats: one for TCP/IP communications and one for Adabas SVC communications. For TCP/IP communications, the format is: `addr:port-number:TCP`. In this case, the addr setting is either the TCP/IP IP address or the host name. The port-number setting must match the EntireX Broker PORT parameter. For Adabas SVC communications, the format is: `'broker-id:SVCnnn:NET'`. In this case, the broker-id setting must match the EntireX Broker BROKER-ID parameter in the Broker ETBFILE DD. The nnn setting must match either the EntireX Broker ADASVC or ADA5SVC parameters in the Broker PARMS DD statement. | None
   Broker Service | The EntireX Broker service for which this destination definition applies. The service identification can be up to 32 characters long. | None
   Broker Service Class | The EntireX Broker service class name for which this destination definition applies. The name can be up to 32 characters long. | None
   Broker Service Name | The EntireX Broker service name for which the EntireX Broker destination definition applies. The name can be up to 32 characters long. | None
   Broker Single Conversation | Whether or not the destination is to run in single conversation mode for Node to Node support. Valid values are Y or N. This parameter should be used for high volume destinations. When this optional parameter is set to yes ("Y") for a destination, all messages are sent using the same EntireX Broker conversation ID. In the event of a failure or if the destination is closed, the same conversation ID is used the next time the destination connection to the EntireX Broker is opened. If there is no active conversation, a new conversation ID is established. | N
   Destination ID | The unique ID for the EntireX Broker destination definition. The specified name must be alphanumeric and be between one and eight characters long. | None
   Destination Name | The unique Name for the EntireX Broker destination definition. The specified name must be alphanumeric and be between one and thirty-two characters long. | None
   Maximum Output size | The maximum output size (in bytes) for the destination. Valid values are 0 or an integer ranging from 4096 through 2,147,483,647. You can specify the value for this parameter in a purely numeric form or use K at the end of the number to specify kilobytes. For example, 4K is the same as 4096. The value for this parameter is used if it is less than or equal to the Maximum Output Size for the Global Definitions and less than or equal to the maximum output allowed for the messaging system queue being defined. If this value is larger than the Maximum Output Size specification or the maximum output size allowed by the messaging system, the smaller value is used. A value of 0 indicates that no specific limit is set for this destination. Instead, the smaller of the Global Definitions Maximum Output Size specification or the maximum output size allowed by the messaging system is used. | 0
   Open at Startup | Whether or not the destination should be opened at Audit Server startup. Valid values are "Y", "N", or "G", with "G" (global value) as the default. When this parameter is set to "Y", the destination is opened at Audit Server startup. When this parameter is set to "N", the destination is not opened at Audit Server startup. When this parameter is set to "G", the decision to open the destination at Auditing Server startup depends on the setting of the Open Destinations in the Global Definitions. If equal to `YES`, the destination is opened at Auditing Server startup; if equal to `NO`, it is not opened. | G
   Queue Full Delay | The number of seconds between retry attempts when resending output transactions to a specific and previously-full webMethods EntireX destination. Valid values are integers in the range from 5 through 300 or the literal "GLOBAL". If "GLOBAL" is specified, the number seconds between retry attempts is set to the value in the Global Definitions Destination Full Delay parameter. | GLOBAL
   Retry Open Count | The number of times that an attempt to open the destination is retried at the interval specified by the Retry Open Interval parameter. Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL". If "GLOBAL" is specified for this parameter, the specification for the Global Definitions Open Retry Count is used. Any retry attempts occur at the interval specified by the Open Retry Interval parameter. A value of zero indicates that no retry attempt to open this destination should occur. | GLOBAL
   Retry Open Interval | The default number of seconds between retry attempts to open the destination. Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL". If "GLOBAL" is specified for this parameter, the specification for the Global Definitions Open Retry Interval is used. A value of zero indicates that no retry attempt to open this destination should occur. Except for a specification of zero, the minimum value that can be specified for this parameter is 5 seconds. | GLOBAL
   SLOG Allowed | Whether or not subscription logging should be activated for this destination definition. Valid values are "Y" (activate subscription logging) or "N" (do not activate subscription logging). | N

5. Press PF5 on the webMethods EntireX Destination Definition screen.

   The EntireX Broker destination definition is saved in the Auditing system file.

## Adding Null Destination Definitions

To use the Adabas Auditing Configuration to add a Null Destination definition to the Auditing system file, complete the following steps:

1. Select D from the Adabas Auditing Configuration main menu to list the Destination definitions, as described above in Listing Destination Definitions.

2. Press PF4 (Add).

   The Create New Destination screen appears.

       17:18:09        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                   Create New Destination                   M-RP1290

                              Code    Function
                              ----    -------------------------
                                A     Create Audit Destination
                                E     Create Broker Destination
                                N     Create Null Destination
                                ?     Help
                                .     Exit
                              ----    -------------------------
                      Code ...  _

       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit                                                  Menu

3. Select option N on the Create New Destination screen.

   The Null Destination Definition screen appears.

       19:41:21        ***** A D A B A S  AUDITING CONFIGURATION *****      2024-09-26
                                Null Destination Definition                 M-RP1240

       Destination Name ...... NULL_DEF________________________
       Destination ID ........ NULL1___

       Active at Startup ..... Y
       Architecture .......... 2
       Open at Startup ....... G
       Maximum Output Size ... _________0

       Command ==>
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        Exit        Save                                      Menu

4. Update the following general fields on the Null Destination Definition screen as described in the following table.

   Field Name | Description | Default
   --- | --- | ---
   Active at Startup | Whether or not this destination definition should be activated for use once it is loaded by the Auditing Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). | Y
   Architecture | The data architecture for fields in the URB* control structures sent to the destination. To calculate a value for this parameter, add the value of the byte order element and the encoding element in the control structure:
       Control Structure Element  Values  Description
       Byte order (b)             0       High-order byte first
                                  1       Low-order byte first
       Encoding Family (e)        0       ASCII encoding family
                                  2       EBCDIC encoding family
   For example, the default value 2, indicates that the byte order element value is "0" and the encoding family value is "2". | 2
   Destination ID | The ID of the Null destination definition. The ID must use alphanumeric characters and be between 1 and 8 characters long. | None
   Destination Name | The name of the Null destination definition. The name must use alphanumeric characters and be between 1 and 32 characters long. | None
   Maximum Output size | The maximum output size (in bytes) for the destination. Valid values are 0 or any integer ranging from 4096 through 2,147,483,647. You can specify the value for this parameter in a purely numeric form or use K at the end of the number to specify kilobytes. For example, 4K is the same as 4096. The value for this parameter is used if it is less than or equal to the Maximum Output Size for the Global Definitions and less than or equal to the maximum output allowed for the messaging system queue being defined. If this value is larger than the Maximum Output Size specification or the maximum output size allowed by the messaging system, the smaller value is used. A value of 0 indicates that no specific limit is set for this destination. Instead, the smaller of the Global Definitions Maximum Output Size specification or the maximum output size allowed by the messaging system is used. | 0
   Open at Startup | Whether or not the destination should be opened at Auditing Server startup. Valid values are "Y", "N", or "G", with "G" as the default. When this parameter is set to "Y", the destination is opened at Auditing Server startup. When this parameter is set to "N", the destination is not opened at Auditing Server startup. When this parameter is set to "G", the decision to open the destination at Auditing Server startup depends on the setting of the Open Destinations in the Global Definitions. If equal to `YES`, the destination is opened at Auditing Server startup; if equal NO, it is not opened. | G

5. Press PF5 to save the Null Destination definition in the Auditing system file.

## Modifying Destination Definitions

1. List the Destination definitions in the Adabas Auditing Configuration, as described above in Listing Destination Definitions.

2. Locate the definition you want to modify on the screen and enter an M in the Sel column for that definition.

   You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the ID of the definition to which the list should be repositioned.

   An appropriate Destination definition screen appears for the Destination you selected.

3. For information about the fields on this screen, refer to the field descriptions described earlier in Adding Destination Definitions.

   Note
   You cannot alter the ID of the Destination definition. If you want to rename a Destination definition, first copy it using the ID you want and then delete the original.

4. When all modifications have been made, press PF5 to save the changes.

## Copying Destination Definitions

To use the Adabas Auditing Configuration to copy a Destination definition in the Auditing system file:

1. List the Destination definitions in the Adabas Auditing Configuration, as described in Listing Destination Definitions.

2. Locate the definition you want to copy on the screen and enter a C in the Sel column for that definition.

   You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the ID of the definition to which the list should be repositioned.

   A dialog appears requesting a Name and ID for the copy of the Destination definition.

        Enter new
        Name: ________________________________
          ID: ________
        or press PF3 to cancel

3. Specify new, unique Name and ID for the copy of the Destination definition and press Enter.

   The Destination definition is copied, and the copy appears on the List of Destinations screen.

## Deleting Destination Definitions

To use the Adabas Auditing Configuration to delete a Destination definition in the Auditing system file:

1. List the Destination definitions in the Adabas Auditing Configuration, as described in Listing Destination Definitions.

2. Locate the definition you want to delete on the screen and enter a D in the Sel column for that definition and press Enter. The Destination definition is deleted.

   You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the ID of the definition to which the list should be repositioned.

### On this page

- Listing Destination Definitions
- Adding Audit Destination Definitions
- Adding EntireX Broker Destination Definitions
- Adding Null Destination Definitions
- Modifying Destination Definitions
- Copying Destination Definitions
- Deleting Destination Definitions