Maintaining Destination Definitions

A destination definition defines the destination of the replicated data. Destination definitions can be created for Adabas, webMethods EntireX (or, EntireX Broker), WebSphere MQ, File, and Null destinations. At least one definition is required for every Event Replicator for Adabas destination you intend to use.

Destination Type Description
Adabas Data is replicated to one or more Adabas files.
EntireX Broker Replicated data is written to an output queue via webMethods EntireX Broker.
WebSphere MQ Replicated data is written to an output queue via IBM WebSphere MQ.
Null Data replication is tested without actually sending the data to a destination.
File Replicated data is written to the CLOG, using TLOG URBLTDOD records.

This document covers the following topics:


Listing Destination Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to list the destination definitions stored in the Replicator system file:

  • Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears showing all of the destination definitions in the Adabas Event Replicator Subsystem.

    15:33:16      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                 List of Destinations                    M-RP1200  
                                                                                   
     Sel   Name   Typ   Sel   Name   Typ   Sel   Name   Typ   Sel   Name   Typ     
     -----------------  -----------------  -----------------  ----------------     
      _  ADA1     ADA    _  52200202 ADA    _  52201616 ADA    _  52203111 ADA     
      _  ADA2     ADA    _  52200303 ADA    _  52201717 ADA    _  52203212 ADA     
      _  D314315  NULL   _  52200404 ADA    _  52201818 ADA    _  52203313 ADA     
      _  D314315A ADA    _  52200505 ADA    _  52201919 ADA    _  52203414 ADA     
      _  D4       ADA    _  52200606 ADA    _  52202101 ADA    _  52203515 ADA     
      _  EXXDEST  ETB    _  52200707 ADA    _  52202202 ADA    _  52203616 ADA     
      _  FILE1    FILE   _  52200808 ADA    _  52202303 ADA    _  52203717 ADA     
      _  IS1-DEST ADA    _  52200909 ADA    _  52202404 ADA    _  52203818 ADA     
      _  MYDEST   ADA    _  52201010 ADA    _  52202505 ADA    _  52203919 ADA     
      _  NULLX1   NULL   _  52201111 ADA    _  52202606 ADA    _  52204101 ADA     
      _  NULLX2   NULL   _  52201212 ADA    _  52202707 ADA    _  52204202 ADA     
      _  XYZ123   ADA    _  52201313 ADA    _  52202808 ADA    _  52204303 ADA     
      _  52005019 ADA    _  52201414 ADA    _  52202909 ADA    _  52204404 ADA     
      _  52200101 ADA    _  52201515 ADA    _  52203010 ADA    _  52204505 ADA     
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help  Repos Exit  Add                -     +                      Menu   

The function keys on this screen perform the following functions:

Function Key Description
PF1/F1 (Help) Provides you with help for this screen.
PF2/F2 (Repos) Provides you with a pop-up panel that allows you to specify the name of the definition you want to locate in the list. Once you have specified a name on the pop-up panel and pressed Enter, the list is repositioned so the name you selected appears first. You can use an asterisk as a wild card character at the end of the definition name or partial definition name you specify on the pop-up panel. Or, you can simply enter the first few characters of the name to reposition the list to the first occurrence in the list of a name starting with those characters.
PF3/F3 (Exit) Returns you to the previous screen.
PF4/F4 (Add) Allows you to add a new definition. A new screen appears.
PF7/F7 (-) Allows you to scroll backwards through the list of definitions.
PF8/F8 (+) Allows you to scroll forwards through the list of definitions.
PF12/F12 (Menu) Returns you to the main menu.

Creating an Adabas Destination Definition

Using Adabas destination definitions, data can be replicated to one or more Adabas files. This section describes how to create an Adabas destination definition using the Adabas Event Replicator Subsystem.

Note:
An Adabas destination can be referenced by no more than one subscription.

To create an Adabas destination definition in the Adabas Event Replicator Subsystem, complete the following steps:

Step 1. Access the Adabas Destination Definition Creation Area

Start of instruction setTo access the Adabas destination definition creation area of the Adabas Event Replicator Subsystem:

  1. Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears.

  2. Press PF4 on the List of Destinations screen.

    The Create New Destination screen appears.

    15:34:11      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                Create New Destination                   M-RP1290  
                                                                                   
                                                                                   
                           Code    Function                                        
                           ----    -------------------------                       
                             A     Create Adabas Destination                       
                             E     Create Broker Destination                       
                             F     Create File Destination                         
                             N     Create Null Destination                         
                             M     Create MQ 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 Adabas Destination Definition screen appears.

    15:35:03      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                             Adabas Destination Definition               M-RP1235  
                                                                                   
                                                                                   
     Destination Name .... ________               Input   Input   Target  Target   
     Destination Active .. Y                 Sel  DBID    File     DBID    File    
     Allow Logging ....... N                 --- ------  ------   ------  ------   
     Retry Interval ...... GLOBAL____         _   _____   ____     _____   ____    
     Retry Count ......... GLOBAL____         _   _____   ____     _____   ____    
     Error Action ........ ALTACTION          _   _____   ____     _____   ____    
     Open at Startup ..... G                  _   _____   ____     _____   ____    
                                              _   _____   ____     _____   ____    
     TLOG Parameters                          _   _____   ____     _____   ____    
     -----------------------                  _   _____   ____     _____   ____    
     Assign Level ........ 0                  _   _____   ____     _____   ____    
     Completion Level .... 0                  _   _____   ____     _____   ____    
     SLOG Write Level .... 0                  _   _____   ____     _____   ____    
     SLOG Read Level ..... 0                                                       
     Adabas Level ........ 0                                                       
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save         -     +                      Menu   

Step 2. Specify General and TLOG Adabas Destination Parameters

Start of instruction setTo use the Adabas Event Replicator Subsystem to supply general and TLOG specifications for an Adabas destination definition, complete the following steps:

  1. Update the following general fields on the Adabas Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Destination Name The unique name for the Adabas destination definition. This is the equivalent of specifying the DESTINATION NAME parameter directly in the Event Replicator Server startup job. The specified name must be alphanumeric and be between one and eight characters long. ---
    Destination Active Whether or not this destination definition should be activated for use once it is loaded by the Event Replicator Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). This is the equivalent of specifying the DACTIVE parameter in the Event Replicator Server startup job. Y
    Allow Logging 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). This is the equivalent of specifying the DLOG parameter in the Event Replicator Server startup job. N
    Retry Interval The default number of seconds between retry attempts to open the destination. This is the equivalent of specifying the DRETRYINTERVAL parameter directly in the Event Replicator Server startup job.

    Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Interval global variable will be 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.

    The value of the Retry Interval global variable.
    Retry Count The number of times that an attempt to open the destination will be retried at the interval specified by the Retry Interval parameter. This is the equivalent of specifying the DRETRYCOUNT parameter directly in the Event Replicator Server startup job.

    Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Count global variable will be used. Any retry attempts will occur at the interval specified by the Retry Interval parameter. A value of zero indicates that no retry attempt to open this destination should occur.

    The value of the Retry Count global variable
    Error Action The action to be taken when an error occurs during replication to an Adabas destination. This is the equivalent of specifying the DAERROR parameter directly in the Event Replicator Server startup job. Valid values are ALTACTION, BACKOUT, or CLOSE.

    In all cases (ALTACTION, BACKOUT, and CLOSE), if response 148 is returned and the SLOG system file is available, the destination is closed.

    If an insert, update, or delete operation fails because a replicated record already exists or does not exist, an appropriate message is issued. If the transaction fails because of an error, a message containing the two-character Adabas command, the database ID, the file number, the response code and the subcode is written. If the DATMETHOD parameter is set to ISN, the text "ISN" will be appended to this message as well as the ISN value. If the DATMETHOD parameter is set to "KEY", the record key will be written in both hexadecimal and readable formats in a separate message.

    Additional actions are taken, based on the value of this parameter. These actions are:

    • ALTACTION: Processing continues with the next update that is part of the same transaction. Some special processing occurs when DAERROR=ALTACTION:

      • If an insert is processed and the record already exists, the record is updated.

      • If an update is processed and the record does not exist, the record is inserted.

      • If a delete is processed and the record does not exist, processing continues with the next record.

      For other errors, the record is skipped.

    • BACKOUT: A message is issued indicating that the transaction will be backed out and then ignored. The current transaction is backed out and processing continues with the next transaction to be replicated.

    • CLOSE: A message is issued indicating that the transaction will be backed out and the destination will be closed. The current transaction is backed out and transaction logging (to the SLOG file) will begin, if defined for the destination.

    ALTACTION
    Open at Startup Whether or not the destination should be opened at Event Replicator 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 Event Replicator Server startup. When this parameter is set to "N", the destination is not opened at Event Replicator Server startup.

    When this parameter is set to "G", the decision to open the destination at Event Replicator Server startup depends on the setting of the Open Destinations at start (GOPEN) global parameter. If GOPEN=YES, the destination is opened at Event Replicator Server startup; if GOPEN=NO, it is not opened.

    This is the equivalent of specifying the DOPEN parameter in the Event Replicator Server startup job.

    G
  2. Update the following TLOG fields on the Adabas Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Assign Level The level of transaction logging that should occur when a transaction is assigned to a destination for output processing. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLASSIGN parameter in the Event Replicator Server startup job. 0
    Completion Level The level of transaction logging that should occur when a transaction has been successfully output to the messaging system. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLCOMP parameter in the Event Replicator Server startup job. 0
    SLOG Write Level The level of transaction logging that should occur when a transaction has been successfully written to the SLOG file. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGWRITE parameter in the Event Replicator Server startup job. 0
    SLOG Read Level The level of transaction logging that should occur when a transaction has been successfully read from the SLOG and is about to be queued for output to the destination. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGREAD parameter in the Event Replicator Server startup job. 0
    Adabas Level The level of transaction logging that should occur when a transaction for an Adabas destination incurred an error. This is the equivalent of specifying the DTLADABAS parameter in the Event Replicator Server startup job. Valid values range from 0 through 3, as described below:
    • 0: No transaction logging should occur.

    • 1: Log event and Adabas error information.

    • 2: Log event, Adabas error information, and file and record data.

    • 3: Log event, Adabas error information, file and record data, and the actual payload.

    0

Step 3. Specify Input and Target Adabas Destination Databases and Files

Start of instruction setTo specify the input and target Adabas destination databases and file:

  1. Update the following fields on the Adabas Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Input DBID The database ID associated with an input file (see the Input File field) for this Adabas destination. This is the equivalent of specifying the DAIDBID parameter directly in the Event Replicator Server startup job. The database ID is numeric and can range from one to 65535.

    The input database ID and file listed in this destination definition must also be included in an SFILE definition in the subscription.

    Multiple input database IDs can be specified in a single destination definition, as needed.

    Only unique combinations of Input DBID and Input File parameters can be specified in a single Adabas destination definition. This implies that the input from a database and file combination can only have a single Adabas target within a specific Adabas destination definition. If you want the input from a database and file combination to go to more than one Adabas target, define multiple Adabas destination definitions.

    ---
    Input File The number of the input file for this Adabas destination definition. This is the equivalent of specifying the DAIFILE parameter directly in the Event Replicator Server startup job.

    The input database ID and file listed in this destination definition must also be included in an SFILE definition in the subscription.

    At least one file must be listed for an Adabas destination definition. Multiple input files can be specified in a single destination definition, as needed.

    Only unique combinations of Input DBID and Input File parameters can be specified in a single Adabas destination definition. This implies that the input from a database and file combination can only have a single Adabas target within a specific Adabas destination definition. If you want the input from a database and file combination to go to more than one Adabas target, define multiple Adabas destination definitions.

    ---
    Target DBID The database ID associated with the target file for the replicated data. This is the equivalent of specifying the DATDBID parameter directly in the Event Replicator Server startup job. The database ID is numeric and can range from one to 65535.

    Multiple target database IDs and files can be specified in a single destination definition, as needed.

    ---
    Target File The number of the target (output) file for the replicated data associated with the input file on the same line in this destination definition. There is no default. This is the equivalent of specifying the DATFILE parameter directly in the Event Replicator Server startup job.

    Multiple target database IDs and files can be specified in a single destination definition, as needed.

    ---

    Note:
    The Sel field on this screen is used to modify parameters for replication specific to a given database and file combination. Skip to the instructions for Step 3. (Optional) Specify File-Related Parameters for the Adabas Destination in this series of steps for information about the fields on the File-Related Parameters screen.

Step 4. (Optional) Specify File-Related Parameters for the Adabas Destination

Start of instruction setTo specify file-related parameters for the Adabas destination:

  1. On the Adabas Destination Definition screen, enter "e", "m", or "s" in the Sel field corresponding to the Adabas file for which you want to specify file-related parameters.

    The File-Related Parameters screen appears.

    15:37:29      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                             Adabas Destination Definition               M-RP1237  
                                File-Related Parameters                            
                                                                                   
     Input               Input                   Target            Target          
     DBID ....    42     File ...    2           DBID ...    63    File ...    3   
                                                                                   
                                                                                   
    Replicate Utility .......... N                                                 
    Replication Method ......... ISN                                               
    After Image Offset ......... _________0                                        
    After Image Key Length ..... ____0                                             
    Before Image Offset ........ _________0                                        
    Before Image Key Length .... ____0                                             
    Key Offset ................. ____0                                             
    Key Length ................. ____0                                             
    Search Buffer.. ____________________________________________________________   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit                                                  Menu   
  2. Update the fields on this screen as described in the following table.

    Note:
    This Input DBID and Input File fields display the database ID and file number of the input file you selected on the previous Adabas destination screen. In addition, the Target DBID and Target File display the database ID and file number of the target file associated with the input file you selected on the previous Adabas destination screen.

    Parameter Name Description Default
    After Image Key Length When the Replication Method parameter is set to "KEY", this parameter is required. If the Replication Method parameter is set to ISN, this parameter may not be specified.

    Specify the length (in bytes) of the key to be used in the after image of the data buffer. Valid values range from 1 through 32,767 bytes.

    This is the equivalent of specifying the DATKEYAIL parameter directly in the Event Replicator Server startup job.

    none
    After Image Offset This optional parameter can only be set if the Replication Method parameter is set to "KEY"; if the Replication Method parameter is set to ISN, this parameter may not be specified.

    Specify the offset of the key to be used in the after image of the data buffer. Valid values range from 0 through 2,147,483,646 bytes. The sum of this parameter value and the length of the key to be used in the after image (After Image Key Length parameter), must be less than or equal to 2,147,483,647 bytes.

    This is the equivalent of specifying the DATKEYAIO parameter directly in the Event Replicator Server startup job.

    0
    Before Image Key Length This optional parameter can only be set if the Replication Method parameter is set to "KEY"; if the Replication Method parameter is set to ISN, this parameter may not be specified. If the Before Image Offset parameter is specified, this parameter must also be specified with a value greater than zero.

    Specify the length (in bytes) of the key to be used in the before image of the data buffer. Valid values range from 1 through 32767 bytes.

    This is the equivalent of specifying the DATKEYBIL parameter directly in the Event Replicator Server startup job.

    none
    Before Image Offset This optional parameter can only be set if the Replication Method parameter is set to "KEY"; if the Replication Method parameter is set to ISN, this parameter may not be specified.

    Specify the offset of the key to be used in the before image of the data buffer. Valid values range from 0 through 2,147,483,646 bytes. The sum of this parameter value and the length of the key to be used in the before image (Before Image Key Length parameter), must be less than or equal to 2,147,483,647 bytes.

    If this parameter is specified, the Before Image Key Length parameter must also be specified with a value greater than zero.

    This is the equivalent of specifying the DATKEYBIO parameter directly in the Event Replicator Server startup job.

    0
    Key Length This optional parameter can only be set if the Replication Method parameter is set to "KEY"; if the Replication Method parameter is set to ISN, this parameter may not be specified. If the Key Offset parameter is specified, this parameter must also be specified with a value greater than zero.

    Specify the length (in bytes) of the key to be used in the before image of the primary key. Valid values range from 1 through 32767 bytes.

    This is the equivalent of specifying the DATKEYKYL parameter directly in the Event Replicator Server startup job.

    none
    Key Offset This optional parameter can only be set if the Replication Method parameter is set to "KEY"; if the Replication Method parameter is set to ISN, this parameter may not be specified.

    Specify the offset of the key to be used in the before image of the primary key. Valid values range from 0 through 32767 bytes. The sum of this parameter value and the length of the key to be used in the before image of the primary key (Key Length parameter), must be less than or equal to 32767 bytes.

    If this parameter is specified, the Key Length parameter must also be specified with a value greater than zero.

    This is the equivalent of specifying the DATKEYKYO parameter directly in the Event Replicator Server startup job.

    0
    Replicate Utility

    This parameter can be specified regardless of the Replication Method selected.

    Specify whether Adabas utility change replication should be activated for a specific target file at Event Replicator Server startup. This is the equivalent of specifying the DAREPLICATEUTI parameter directly in the Event Replicator Server startup job. Valid values are "Y" and "N".

    If "Y" is specified, utility replication is activated for the target file at Event Replicator Server startup; if "N" is specified, utility replication is not activated for the target file.

    For more information about replicating utility functions, read Replicating Utility Functions.

    N
    Replication Method Specify the method to be used when searching for a record on the target database. Valid values are "ISN" and "KEY". This is the equivalent of specifying the DATMETHOD parameter directly in the Event Replicator Server startup job.

    When this parameter is set to "KEY", the parameters Search Buffer, After Image Offset, After Image Key Length, Before Image Offset, Before Image Key Length, Key Offset, and Key Length may also be supplied to indicate where to find the key in the replicated data. All of these parameters are optional except Search Buffer and After Image Length, which are required.

    ISN
    Search Buffer When the Replication Method parameter is set to "KEY", this parameter is required. If the Replication Method parameter is set to ISN, this parameter may not be specified.

    Specify a search buffer to be used for keyed replication. Up to 60 alphanumeric characters can be specified.

    This is the equivalent of specifying the DATKEYSB parameter directly in the Event Replicator Server startup job.

    none
  3. When all file-related parameters have been specified for the file, press PF3 to return to the first Adabas Destination Definition screen.

Step 5. Save the Adabas Destination Definition

Start of instruction setTo save the Adabas destination definition in the Replicator system file:

  • Press PF5 on the Adabas Destination Definition screen.

    The Adabas destination definition is saved in the Replicator system file.

Creating an EntireX Broker Destination Definition

Using an EntireX Broker destination definition, replicated data is written to an output queue via webMethods EntireX. Be sure to read Using webMethods EntireX as the Messaging System prior to using webMethods EntireX as the messaging subsystem.

To create an EntireX Broker destination definition in the Adabas Event Replicator Subsystem, complete the following steps:

Step 1. Access the EntireX Broker Destination Definition Creation Area

Start of instruction setTo access the EntireX Broker destination definition creation area of the Adabas Event Replicator Subsystem:

  1. Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears.

  2. Press PF4 on the List of Destinations screen.

    The Create New Destination screen appears.

    15:34:11      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                Create New Destination                   M-RP1290  
                                                                                   
                                                                                   
                           Code    Function                                        
                           ----    -------------------------                       
                             A     Create Adabas Destination                       
                             E     Create Broker Destination                       
                             F     Create File Destination                         
                             N     Create Null Destination                         
                             M     Create MQ 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.

    13:43:20      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2017-10-23 
                                    EntireX Broker                       M-RP1220   
                                Destination Definition                              
                                                                                    
    Dest Name ..... CMAP____  EntireX Broker ..... UHO2135:SVC229:NET______________ 
    Architecture ........ _2  Broker Service ..... SEXX____________________________ 
    Threshold ... _________5  Service Name ....... ETBSERV_________________________ 
    Destination Active ... Y  Service Class ...... ARF2____________________________ 
    Allow Logging ........ N  Retry Interval ..... GLOBAL____                       
    Replicate Util Chgs .. N  Retry Count ........ GLOBAL____                       
    Event Logging ........ N  Queue Full Delay ... GLOBAL____                       
    Open at Startup ...... G  Single Conversation mode .. NO_                 
    Max Out Size. __________  EntireX Token ...... ________________________________ 
    DSTATLOG ............. N  EntireX Userid ..... ________________________________ 
    TLOG Parms                Heartbeat Interval . _________0                       
    ------------------------               Destination Class ............. ________ 
    Assign Level ......... 0               Destination Class Parameter Data .....   
    Completion Level ..... 0               ________________________________________ 
    SLOG Write Level ..... 0               ________________________________________ 
    SLOG Read Level ...... 0               ________________________________________ 
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save                                      Menu

Step 2. Specify General and TLOG EntireX Broker Destination Parameters

Start of instruction setTo use the Adabas Event Replicator Subsystem to supply general and TLOG specifications for an EntireX Broker destination definition, complete the following steps:

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

    Parameter Name Specify Default
    Allow Logging 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). This is the equivalent of specifying the DLOG parameter in the Event Replicator Server startup job. N
    Architecture The data architecture for fields in the URB* control structures sent to the EntireX Broker destination.

    For complete information on calculating a value for this parameter, read DARC..

    2
    Broker Service The EntireX Broker service for which this destination definition applies. The service identification can be up to 32 characters long. This is the equivalent of specifying the DETBSERVICE parameter directly in the Event Replicator Server startup job. ---
    Dest Name The unique name for the EntireX Broker destination definition. This is the equivalent of specifying the DESTINATION NAME parameter directly in the Event Replicator Server startup job. The specified name must be alphanumeric and be between one and eight characters long. ---
    Destination Active Whether or not this destination definition should be activated for use once it is loaded by the Event Replicator Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). This is the equivalent of specifying the DACTIVE parameter in the Event Replicator Server startup job. Y
    Destination Class Leave this field blank for now. It is described later in this section. ---
    Destination Class Parameter Data Leave this field blank for now. It is described later in this section. ---
    DSTATLOG

    Decides whether or not the associated destination should receive interval statistics published by the Event Replicator Server. This parameter is used with Replication Monitoring. Valid values are Y or N (YES or NO).

    A value of Y indicates that interval statistics should be published to the destination; a value of N indicates they should not.

    A destination defined with DSTATLOG=Y cannot be specified in a subscription.

    N
    EntireX 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 should match the EntireX Broker PORT parameter.

    For Adabas SVC communications, the format is:

    'broker-id:SVCnnn:NET'

    In this case, the broker-id setting should match the EntireX Broker BROKER-ID parameter in the Broker ETBFILE DD. The nnn setting should match either the EntireX Broker ADASVC or ADA5SVC parameters in the Broker PARMS DD statement.

    If no name is specified, the default EntireX Broker ID specified by the ETBBROKERID parameter is used. This is the equivalent of specifying the DETBBROKERID in the Event Replicator Server startup job.

    ---
    EntireX Token

    This is the equivalent of the DETBTOKEN subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies the webMethods EntireX token.

    This optional parameter can only be specified when DETBSCONV=YES.

    Refer to TOKEN in the EntireX Broker ACI for Assembler section of the webMethods EntireX documentation for more information on usage and syntax.

    REPTOR-DEST-destination name
    EntireX Userid

    This is the equivalent of the DETBUSERID subparameter subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies the webMethods user ID.

    This optional parameter can only be specified when DETBSCONV=YES.

    Refer to TOKEN in the EntireX Broker ACI for Assembler section of the webMethods EntireX documentation for more information on usage and syntax.

    REPTOR--node-----jobname
    Event Logging Whether or not events should be logged by the Event Replicator Server and sent to this destination. This is the equivalent of specifying the DEVENTLOG parameter directly in the Event Replicator Server startup job. Valid values are "Y" or "N". When this optional parameter is set to "Y", Event Replicator Server events are logged to the destination. When this parameter is set to "N" (the default), they are not.

    Event Replicator Server events are logged in URBS elements. These URBS elements are sent to destinations related to the event itself. The URBS elements are also sent to any other destinations you have defined "Event Logging =Y". If a related destination also is defined with "Event Logging =Y", it will only receive one instance of the URBS element.

    To access this log of Event Replicator Server events in the destination queue, you must supply your own application that reads the event URBS elements in the destination queue. If such an application does not exist, the logged events simply sit in the queue.

    N
    Heartbeat Interval

    This is the equivalent of the DHBINTERVAL subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies the interval (in seconds) at which the heartbeat should be published to a destination. Valid values are 0 or 60 to 86400 (24 hours).

    Use this subparameter to set the interval at which heartbeat events are sent to a particular destination. Information for a heartbeat event is collected if at least Heartbeat Interval (DHBINTERVAL) seconds have passed since a heartbeat event was last sent to the destination. This heartbeat information is inserted into the replication data stream at the exit from the Event Replicator Server (destination processing).

    A value of zero (0) indicates that a heartbeat event should not be published for a particular destination.

    The Heartbeat Interval (DHBINTERVAL) subparameter is only allowed for destinations defined with DTYPE=ETBROKER, DTYPE=MQSERIES, or DTYPE=NULL.

    The DHBINTERVAL parameter is only allowed for destinations defined with DCLASS=SAGTARG.

    Note:
    The interval between creating heartbeat events may be slightly longer (e.g. 10 seconds longer) than the interval specified for this parameter.

    0
    Max Output Size The maximum output size (in bytes) for the destination. This is the equivalent of specify the DMAXOUTPUTSIZE parameter directly in the Event Replicator Server startup job. 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, DMAXOUTPUTSIZE=4K is the same as DMAXOUTPUTSIZE=4096.

    The value for this parameter will be used if it is less than or equal to the maximum output size for the Event Replicator Server (specified using the MAXOUTPUTSIZE global parameter) and less than or equal to the maximum output allowed for the messaging system queue being defined. If this value is larger than the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system, the smaller value will be used.

    A value of 0 indicates that no specific limit is set for this destination. Instead, the smaller of the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system will be used.

    0
    Open at Startup Whether or not the destination should be opened at Event Replicator 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 Event Replicator Server startup. When this parameter is set to "N", the destination is not opened at Event Replicator Server startup.

    When this parameter is set to "G", the decision to open the destination at Event Replicator Server startup depends on the setting of the Open Destinations at start (GOPEN) global parameter. If GOPEN=YES, the destination is opened at Event Replicator Server startup; if GOPEN=NO, it is not opened.

    This is the equivalent of specifying the DOPEN parameter in the Event Replicator Server startup job.

    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 word "GLOBAL". If the value "GLOBAL" is specified, the number seconds between retry attempts is set to the value of the GQFULLDELAY initialization parameter.

    This is the equivalent of specifying the DQFULLDELAY parameter directly in the Event Replicator Server startup job.

    GLOBAL
    Replicate Util Chgs Whether Adabas utility change replication should be activated for a destination at Event Replicator Server startup. This is the equivalent of specify the DREPLICATEUTI parameter directly in the Event Replicator Server startup job. Valid values are "Y" and "N".

    If "Y" is specified, utility replication is activated for the destination at Event Replicator Server startup; if "N" is specified, utility replication is not activated for the destination.

    For more information about replicating utility functions, read Replicating Utility Functions.

    N
    Retry Count The number of times that an attempt to open the destination will be retried at the interval specified by the Retry Interval parameter. This is the equivalent of specifying the DRETRYCOUNT parameter directly in the Event Replicator Server startup job.

    Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Count global variable will be used. Any retry attempts will occur at the interval specified by the Retry Interval parameter. A value of zero indicates that no retry attempt to open this destination should occur.

    The value of the Retry Count global variable
    Retry Interval The default number of seconds between retry attempts to open the destination. This is the equivalent of specifying the DRETRYINTERVAL parameter directly in the Event Replicator Server startup job.

    Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Interval global variable will be 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.

    The value of the Retry Interval global variable.
    Service Class The EntireX Broker service class name for which this destination definition applies. The name can be up to 32 characters long. This is the equivalent of specifying the DETBSERVICECLASS parameter in the Event Replicator Server startup job. ---
    Service Name The EntireX Broker service name for which the EntireX Broker destination definition applies. This is the equivalent of specifying the DETBSERVICENAME parameter directly in the Event Replicator Server startup job. The name can be up to 32 characters long. ---
    Single Conversation Mode

    This is the equivalent of the DETBSCONV subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies whether or not the destination is to run in single conversation mode for Node to Node support. Valid values are YES or NO. This parameter should be used for high volume destinations.

    When this optional parameter is set to YES 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 will be used the next time the destination connection to the EntireX Broker is opened. If there is no active conversation, then a new conversation ID will be established.

    N
    Threshold The number of messages that will be sent to the EntireX Broker destination before a commit is performed for those messages.

    For complete information on specifying a value for this parameter, read DCOMMITTHRESHOLD.

    5
  2. Update the following TLOG fields on the EntireX Broker Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Assign Level The level of transaction logging that should occur when a transaction is assigned to a destination for output processing. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLASSIGN parameter in the Event Replicator Server startup job. 0
    Completion Level The level of transaction logging that should occur when a transaction has been successfully output to the messaging system. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLCOMP parameter in the Event Replicator Server startup job. 0
    SLOG Write Level The level of transaction logging that should occur when a transaction has been successfully written to the SLOG file. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGWRITE parameter in the Event Replicator Server startup job. 0
    SLOG Read Level The level of transaction logging that should occur when a transaction has been successfully read from the SLOG and is about to be queued for output to the destination. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGREAD parameter in the Event Replicator Server startup job. 0

Step 3. (Optional) Specify Destination Class Information, If Applicable

The Destination Class and Destination Class Parameter Data fields can be used to invoke and pass parameters to the Event Replicator Target Adapter for this destination. The fields are located at the bottom of the EntireX Broker destination screen. Do not use these fields unless you want to invoke and pass parameters to the Event Replicator Target Adapter for the destination or unless otherwise requested by a Software AG support representative.

If applicable, use the Destination Class (DCLASS) field to specify the destination class for this destination definition. Valid values are blank or "SAGTARG" (if Event Replicator Target Adapter processing should be invoked). There is no default.

Note:
DCLASS=SAGTARG cannot be specified for destinations with DTYPE=ADABAS or FILE. It is only valid for webMethods EntireX, WebSphere MQ, or NULL destinations. When DCLASS=SAGTARG is specified, the ADARUN RPLPARMS parameter must be set to "FILE" or "BOTH" to provide access to any field table (GFFT) definitions.

If you specify a value for the Destination Class field, you can optionally use the Destination Class Parameter Data (DCLASSPARM) field to specify up to 120 bytes of character data to be passed to the optional destination output user exit.

If either DCLASS=SAGTARG or DCLASS=SAGTRGB is specified to invoke support for the Event Replicator Target Adapter, you may want to specify one or more of the following keyword parameters:

Note:
These parameter keywords must be specified in uppercase.

ADA

The ADA keyword is available for use with the SAGTARG DCLASS exit.

Specify the ADA keyword in the DCLASSPARM parameter if the target of the destination requires the Adabas 2-byte short name be included with the schema for all fields.

NOSPRE

The NOSPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

Specify the NOSPRE keyword in the DCLASSPARM parameter if you do not want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter. When NOSPRE is specified, the schema file name (Predict view name) alone is used for the table names; when NOSPRE is not specified, the subscription name prefixes the schema file name in the table names.

Note:
Oracle identifiers are limited to 30 characters. If NOSPRE is not specified and an Oracle RDBMS is used by the Event Replicator Target Adapter, the identifier names may exceed 30 characters and errors may occur. We recommend using NOSPRE if an Oracle RDBMS is also used.

SPRE

Specify the SPRE keyword in the DCLASSPARM parameter if you do want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter.

The notation is SPRE=xxxxxxxx. Where xxxxxxxx can be a subscription prefix to be used instead of the subscription name used in the job execution. The prefix can be 1 to 8 characters in size.

The SPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

OPTIONS

The OPTIONS keyword parameter can be used to specify options for the destination. Specify the OPTIONS keyword parameter, using the syntax OPTIONS=nnnn. Possible values of the OPTIONS (nnnn) are listed in the following table. However, if you want to combine options, add their values together and enter the total value.

For example, if you want to combine option 32 (to send the full image on an update) and option 64 (to set the XML transaction committed time value to local time instead of GMT/UTC), specify OPTIONS=96 (with 96 being the sum of 32 and 64).

Option Value Description
1 Specify OPTIONS=1 to send the full image on an insert.
2 Specify OPTIONS=2 to indicate that long names should be used. This option will cause long names to be sent in place of the default short names used for various elements and attributes. Short names are the default and save on the amount of data being transferred. Long names make for better readability. For example, the short name <F> would appear as <Field> using long names.
4 Specify OPTIONS=4 to ensure that invalid XML characters found in alphanumeric fields are not translated to spaces.
8 Specify OPTIONS=8 to ensure that trailing blanks in alphanumeric fields are not removed.
16 Specify OPTIONS=16 to ensure that characters used by XML are not replaced automatically with predefined entity references. For example, if OPTIONS=16 is set, the ampersand (&) character would not be replaced with the literal "&amp;".
32 Specify OPTIONS=32 to send the full image on an update. The full before image (if available) and after image of all fields are sent for an update and insert, even if the field values were not changed or are null.

Note:
This option is mutually exclusive with option 128. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

64 Specify OPTIONS=64 to set the XML transaction committed time value to local time instead of GMT/UTC.
128 Specify OPTIONS=128 if the before image is not to be included when a field is updated/changed if the before image data storage records are included. Primary field before images will still be included because the key is needed to find the record that is to be changed.

Note:
This option is mutually exclusive with option 32. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

256 Specify OPTIONS=256 to suppress ARMXL004I information messages.
TRACE

The TRACE keyword parameter can be used to specify the contents of the trace. Specify the TRACE keyword parameter using the syntax TRACE=nnnn. Possible values of the TRACE (nnnn) are listed in the following table. However, if you want to trace multiple control blocks, add their trace values together and enter the total value. For example, to trace the before and after images of the URBD control blocks, you would specify TRACE=24 because the sum of 8 (URBD control block before image) and 16 (URBD control block after image) is 24.

Note:
If tracing is enabled using this keyword parameter, be sure to include the following JCL statement in the startup JCL of the Event Replicator Server:
//DDTRACE1 DD SYSOUT=X

Settings for DCLASS=SAGTARG

Trace Value Description
1 Trace the URBS control block.
2 Trace the URBT control block.
4 Trace the URBR control block.
8 Trace the URBD control block before image.
16 Trace the URBD control block after image.
32 Trace the URBF/URBG control block before image.
64 Trace the URBF/URBG control block after image.
128 Trace the send buffer.
256 Trace the URBY control block.
512 Trace the URBO control block.
1024 Trace the output parameters.
2048 Trace the subscription table.

Settings for DCLASS=SAGTRGB

Trace Value Description
1 Trace the output buffer.
2 Trace the URBD control block after image.
4 Trace the URBR control block.
8 Trace the URBT control block.
16 Trace the URBH control block.
32 Trace the URBF/URBG control block before image.
64 Trace the URBS control block.
128 Trace the URBY control block.
256 Trace the URBO control block.
512 Trace the URBD AI control blocks
1024 Trace the URBF/G AI control blocks
2048 Trace the subscription table.

Step 4. Save the EntireX Broker Destination Definition

Start of instruction setTo save the EntireX Broker destination definition in the Replicator system file:

  • Press PF5 on the webMethods EntireX Destination Definition screen.

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

Creating a WebSphere MQ Destination Definition

Using a WebSphere MQ destination definition, replicated data is written to an output queue via IBM WebSphere MQ. Be sure to read Using WebSphere MQ as the Messaging System prior to using WebSphere MQ as the messaging subsystem.

Note:
If you are running on z/OS using IBM WebSphere MQ Series definitions for your Event Replicator DESTINATION or IQUEUE definitions, a S0D3 abend can occur if you run it as a started task and specify the parameter REUSASID=YES. This is a documented IBM WebSphere MQ Series issue.

To create a WebSphere MQ destination definition in the Adabas Event Replicator Subsystem, complete the following steps:

Step 1. Access the WebSphere MQ Destination Definition Creation Area

Start of instruction setTo access the WebSphere MQ destination definition creation area of the Adabas Event Replicator Subsystem:

  1. Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears.

  2. Press PF4 on the List of Destinations screen.

    The Create New Destination screen appears.

    15:34:11      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                Create New Destination                   M-RP1290  
                                                                                   
                                                                                   
                           Code    Function                                        
                           ----    -------------------------                       
                             A     Create Adabas Destination                       
                             E     Create Broker Destination                       
                             F     Create File Destination                         
                             N     Create Null Destination                         
                             M     Create MQ Destination                           
                             ?     Help                                            
                             .     Exit                                            
                            ----   -------------------------                       
                                                                                   
                   Code ...  _                                                     
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit                                                  Menu   
  3. Select option M on the Create New Destination screen.

    The MQSeries Destination Definition screen appears.

    17:11:20      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2017-10-23
                           MQSeries Destination Definition               M-RP1210  
                                                                                   
    Destination Name .... ________  Architecture ... 2_                            
    Queue Manager Name... ________________________________________________         
    Queue Name .......... ________________________________________________         
    Dynamic Queue Name... ________________________________________________         
    Destination Active... Y       Retry Interval ................... GLOBAL____    
    Allow Logging ....... Y       Retry Count ...................... GLOBAL____    
    Threshold .. _________5       Max Output Size .................. ______8192    
    Replicate Util Chgs.. N       Destination Class .................. ________    
    Event Logging ....... N       MQ Format .......................... ________    
    Open at Startup ..... G       MQSeries Coded Character Set ID .. __________    
    DSTATLOG ............ N       Queue Full Delay ................. GLOBAL____    
    TLOG Parms                    Heartbeat Interval ............... _________0    
    -----------------------       Destination Class Parameter Data ............    
    Assign Level ........ 0       _____________________________________________    
    Completion Level .... 0       _____________________________________________    
    SLOG Write Level .... 0       ______________________________                   
    SLOG Read Level ..... 0                                                        
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save                                      Menu

Step 2. Specify General and TLOG WebSphere MQ Destination Parameters

Start of instruction setTo use the Adabas Event Replicator Subsystem to supply general and TLOG specifications for a WebSphere MQ destination definition, complete the following steps:

  1. Update the following general fields on the MQSeries Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Allow Logging 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). This is the equivalent of specifying the DLOG parameter in the Event Replicator Server startup job. N
    Architecture The data architecture for fields in the URB* control structures sent to the WebSphere MQ destination.

    For complete information on calculating a value for this parameter, read DARC..

    2
    Destination Active Whether or not this destination definition should be activated for use once it is loaded by the Event Replicator Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). This is the equivalent of specifying the DACTIVE parameter in the Event Replicator Server startup job. Y
    Destination Class Leave this field blank for now. It is described later in this section. ---
    Destination Class Parameter Data Leave this field blank for now. It is described later in this section. ---
    Destination Name The unique name for the WebSphere MQ destination definition. This is the equivalent of specifying the DESTINATION NAME parameter directly in the Event Replicator Server startup job. The specified name must be alphanumeric and be between one and eight characters long. ---
    DSTATLOG

    Decides whether or not the associated destination should receive interval statistics published by the Event Replicator Server. This parameter is used with Replication Monitoring. Valid values are Y or N (YES or NO).

    A value of Y indicates that interval statistics should be published to the destination; a value of N indicates they should not.

    A destination defined with DSTATLOG=Y cannot be specified in a subscription.

    N
    Dynamic Queue Name The WebSphere MQ dynamic queue name. This is the equivalent of specifying the DMQDYNQNAME parameter directly in the Event Replicator Server startup job. The name can be up to 48 characters long. blanks
    Event Logging Whether or not events should be logged by the Event Replicator Server and sent to this destination. This is the equivalent of specifying the DEVENTLOG parameter directly in the Event Replicator Server startup job. Valid values are "Y" or "N". When this optional parameter is set to "Y", Event Replicator Server events are logged to the destination. When this parameter is set to " N" (the default), they are not.

    Event Replicator Server events are logged in URBS elements. These URBS elements wre sent to destinations related to the event itself. The URBS elements are also sent to any other destinations you have defined "Event Logging =Y". If a related destination also is defined with "Event Logging =Y", it will only receive one instance of the URBS element.

    To access this log of Event Replicator Server events in the destination queue, you must supply your own application that reads the event URBS elements in the destination queue. If such an application does not exist, the logged events simply sit in the queue.

    N
    Heartbeat Interval

    This is the equivalent of the DHBINTERVAL subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies the interval (in seconds) at which the heartbeat should be published to a destination. Valid values are 0 or 60 to 86400 (24 hours).

    Use this subparameter to set the interval at which heartbeat events are sent to a particular destination. Information for a heartbeat event is collected if at least Heartbeat Interval (DHBINTERVAL) seconds have passed since a heartbeat event was last sent to the destination. This heartbeat information is inserted into the replication data stream at the exit from the Event Replicator Server (destination processing).

    A value of zero (0) indicates that a heartbeat event should not be published for a particular destination.

    The Heartbeat Interval (DHBINTERVAL) subparameter is only allowed for destinations defined with DTYPE=ETBROKER, DTYPE=MQSERIES, or DTYPE=NULL.

    The DHBINTERVAL parameter is only allowed for destinations defined with DCLASS=SAGTARG.

    Note:
    The interval between creating heartbeat events may be slightly longer (e.g. 10 seconds longer) than the interval specified for this parameter.

    0
    Max Output Size The maximum output size (in bytes) for the destination. This is the equivalent of specify the DMAXOUTPUTSIZE parameter directly in the Event Replicator Server startup job. 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, DMAXOUTPUTSIZE=4K is the same as DMAXOUTPUTSIZE=4096.

    The value for this parameter will be used if it is less than or equal to the maximum output size for the Event Replicator Server (specified using the MAXOUTPUTSIZE global parameter) and less than or equal to the maximum output allowed for the messaging system queue being defined. If this value is larger than the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system, the smaller value will be used.

    A value of 0 indicates that no specific limit is set for this destination. Instead, the smaller of the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system will be used.

    0
    MQ Format The optional MQ format name. The format name can be up to eight characters long. This is the equivalent of specifying the DMQFORMAT parameter in the Event Replicator Server startup job.

    Note:
    You cannot specify a value for this parameter if a value has not also been specified for the Destination Class parameter.

    blanks
    MQSeries Coded Character Set ID The destination-specific coded character set ID (CCSID) for the WebSphere MQ destination. This is the equivalent of specifying the DMQCCSID parameter in the Event Replicator Server startup job. Valid values range from 0 through 2,147,483,647.

    This optional parameter can only be specified when the DCLASS or DEXIT parameters are specified.

    The Event Replicator Server does not attempt to verify the value of this parameter as the character codes may be changed or added to as time goes on. The value for this parameter is simply passed in the appropriate WebSphere MQ request as the CCSID.

    0
    Open at Startup Whether or not the destination should be opened at Event Replicator 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 Event Replicator Server startup. When this parameter is set to "N", the destination is not opened at Event Replicator Server startup.

    When this parameter is set to "G", the decision to open the destination at Event Replicator Server startup depends on the setting of the Open Destinations at start (GOPEN) global parameter. If GOPEN=YES, the destination is opened at Event Replicator Server startup; if GOPEN=NO, it is not opened.

    This is the equivalent of specifying the DOPEN parameter in the Event Replicator Server startup job.

    G
    Queue Full Delay The number of seconds between retry attempts when resending output transactions to a specific and previously-full WebSphere MQ destination. Valid values are integers in the range from "5" through "300" or the word "GLOBAL". If the value "GLOBAL" is specified, the number seconds between retry attempts is set to the value of the GQFULLDELAY initialization parameter.

    This is the equivalent of specifying the DQFULLDELAY parameter directly in the Event Replicator Server startup job.

    GLOBAL
    Queue Manager Name The WebSphere MQ queue manager name. The name can be up to 48 characters long. This is the equivalent of specifying the DMQQMGRNAME parameter in the Event Replicator Server startup job. ---
    Queue Name The WebSphere MQ queue name. The name can be up to 48 characters long. There is no default. This is the equivalent of specifying the DMQQNAME parameter in the Event Replicator Server startup job. ---
    Replicate Util Chgs Whether Adabas utility change replication should be activated for a destination at Event Replicator Server startup. This is the equivalent of specify the DREPLICATEUTI parameter directly in the Event Replicator Server startup job. Valid values are "Y" and "N".

    If "Y" is specified, utility replication is activated for the destination at Event Replicator Server startup; if "N" is specified, utility replication is not activated for the destination.

    For more information about replicating utility functions, read Replicating Utility Functions.

    N
    Retry Count The number of times that an attempt to open the destination will be retried at the interval specified by the Retry Interval parameter. This is the equivalent of specifying the DRETRYCOUNT parameter directly in the Event Replicator Server startup job.

    Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Count global variable will be used. Any retry attempts will occur at the interval specified by the Retry Interval parameter. A value of zero indicates that no retry attempt to open this destination should occur.

    The value of the Retry Count global variable
    Retry Interval The default number of seconds between retry attempts to open the destination. This is the equivalent of specifying the DRETRYINTERVAL parameter directly in the Event Replicator Server startup job.

    Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Interval global variable will be 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.

    The value of the Retry Interval global variable
    Threshold The number of messages that will be sent to the WebSphere MQ destination before a commit is performed for those messages. This is the equivalent of specifying the DCOMMITTHRESHOLD parameter directly in the Event Replicator Server startup job.

    The term "commit" in this context means that the Event Replicator Server informs the messaging system that all messages sent (since the last commit) should be made permanent. In the case of WebSphere MQ, commit means that the Event Replicator Server will issue an MQCMIT call for the queue.

    5
  2. Update the following TLOG fields on the MQSeries Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Assign Level The level of transaction logging that should occur when a transaction is assigned to a destination for output processing. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLASSIGN parameter in the Event Replicator Server startup job. 0
    Completion Level The level of transaction logging that should occur when a transaction has been successfully output to the messaging system. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLCOMP parameter in the Event Replicator Server startup job. 0
    SLOG Read Level The level of transaction logging that should occur when a transaction has been successfully read from the SLOG and is about to be queued for output to the destination. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGREAD parameter in the Event Replicator Server startup job. 0
    SLOG Write Level The level of transaction logging that should occur when a transaction has been successfully written to the SLOG file. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGWRITE parameter in the Event Replicator Server startup job. 0

Step 3. (Optional) Specify Destination Class Information, If Applicable

The Destination Class and Destination Class Parameter Data fields can be used to invoke and pass parameters to the Event Replicator Target Adapter for this destination. The fields are located at the right of the WebSphere MQ destination screen. Do not use these fields unless you want to invoke and pass parameters to the Event Replicator Target Adapter for the destination or unless otherwise requested by a Software AG support representative.

If applicable, use the Destination Class (DCLASS) field to specify the destination class for this destination definition. Valid values are blank or "SAGTARG" (if Event Replicator Target Adapter processing should be invoked). There is no default.

Note:
DCLASS=SAGTARG cannot be specified for destinations with DTYPE=ADABAS or FILE. It is only valid for webMethods EntireX, WebSphere MQ, or NULL destinations. When DCLASS=SAGTARG is specified, the ADARUN RPLPARMS parameter must be set to "FILE" or "BOTH" to provide access to any field table (GFFT) definitions.

If you specify a value for the Destination Class field, you can optionally use the Destination Class Parameter Data (DCLASSPARM) field to specify up to 120 bytes of character data to be passed to the optional destination output user exit.

If either DCLASS=SAGTARG or DCLASS=SAGTRGB is specified to invoke support for the Event Replicator Target Adapter, you may want to specify one or more of the following keyword parameters:

Note:
These parameter keywords must be specified in uppercase.

ADA

The ADA keyword is available for use with the SAGTARG DCLASS exit.

Specify the ADA keyword in the DCLASSPARM parameter if the target of the destination requires the Adabas 2-byte short name be included with the schema for all fields.

NOSPRE

The NOSPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

Specify the NOSPRE keyword in the DCLASSPARM parameter if you do not want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter. When NOSPRE is specified, the schema file name (Predict view name) alone is used for the table names; when NOSPRE is not specified, the subscription name prefixes the schema file name in the table names.

Note:
Oracle identifiers are limited to 30 characters. If NOSPRE is not specified and an Oracle RDBMS is used by the Event Replicator Target Adapter, the identifier names may exceed 30 characters and errors may occur. We recommend using NOSPRE if an Oracle RDBMS is also used.

SPRE

Specify the SPRE keyword in the DCLASSPARM parameter if you do want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter.

The notation is SPRE=xxxxxxxx. Where xxxxxxxx can be a subscription prefix to be used instead of the subscription name used in the job execution. The prefix can be 1 to 8 characters in size.

The SPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

OPTIONS

The OPTIONS keyword parameter can be used to specify options for the destination. Specify the OPTIONS keyword parameter, using the syntax OPTIONS=nnnn. Possible values of the OPTIONS (nnnn) are listed in the following table. However, if you want to combine options, add their values together and enter the total value.

For example, if you want to combine option 32 (to send the full image on an update) and option 64 (to set the XML transaction committed time value to local time instead of GMT/UTC), specify OPTIONS=96 (with 96 being the sum of 32 and 64).

Option Value Description
1 Specify OPTIONS=1 to send the full image on an insert.
2 Specify OPTIONS=2 to indicate that long names should be used. This option will cause long names to be sent in place of the default short names used for various elements and attributes. Short names are the default and save on the amount of data being transferred. Long names make for better readability. For example, the short name <F> would appear as <Field> using long names.
4 Specify OPTIONS=4 to ensure that invalid XML characters found in alphanumeric fields are not translated to spaces.
8 Specify OPTIONS=8 to ensure that trailing blanks in alphanumeric fields are not removed.
16 Specify OPTIONS=16 to ensure that characters used by XML are not replaced automatically with predefined entity references. For example, if OPTIONS=16 is set, the ampersand (&) character would not be replaced with the literal "&amp;".
32 Specify OPTIONS=32 to send the full image on an update. The full before image (if available) and after image of all fields are sent for an update and insert, even if the field values were not changed or are null.

Note:
This option is mutually exclusive with option 128. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

64 Specify OPTIONS=64 to set the XML transaction committed time value to local time instead of GMT/UTC.
128 Specify OPTIONS=128 if the before image is not to be included when a field is updated/changed if the before image data storage records are included. Primary field before images will still be included because the key is needed to find the record that is to be changed.

Note:
This option is mutually exclusive with option 32. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

256 Specify OPTIONS=256 to suppress ARMXL004I information messages.
TRACE

The TRACE keyword parameter can be used to specify the contents of the trace. Specify the TRACE keyword parameter using the syntax TRACE=nnnn. Possible values of the TRACE (nnnn) are listed in the following table. However, if you want to trace multiple control blocks, add their trace values together and enter the total value. For example, to trace the before and after images of the URBD control blocks, you would specify TRACE=24 because the sum of 8 (URBD control block before image) and 16 (URBD control block after image) is 24.

Note:
If tracing is enabled using this keyword parameter, be sure to include the following JCL statement in the startup JCL of the Event Replicator Server:
//DDTRACE1 DD SYSOUT=X

Settings for DCLASS=SAGTARG

Trace Value Description
1 Trace the URBS control block.
2 Trace the URBT control block.
4 Trace the URBR control block.
8 Trace the URBD control block before image.
16 Trace the URBD control block after image.
32 Trace the URBF/URBG control block before image.
64 Trace the URBF/URBG control block after image.
128 Trace the send buffer.
256 Trace the URBY control block.
512 Trace the URBO control block.
1024 Trace the output parameters.
2048 Trace the subscription table.

Settings for DCLASS=SAGTRGB

Trace Value Description
1 Trace the output buffer.
2 Trace the URBD control block after image.
4 Trace the URBR control block.
8 Trace the URBT control block.
16 Trace the URBH control block.
32 Trace the URBF/URBG control block before image.
64 Trace the URBS control block.
128 Trace the URBY control block.
256 Trace the URBO control block.
512 Trace the URBD AI control blocks
1024 Trace the URBF/G AI control blocks
2048 Trace the subscription table.

Step 4. Save the WebSphere MQ Destination Definition

Start of instruction setTo save the WebSphere MQ destination definition in the Replicator system file:

  • Press PF5 on the MQSeries Destination Definition screen.

    The WebSphere MQ destination definition is saved in the Replicator system file.

Creating a File Destination Definition

Using a File destination definition, replicated data is written to the CLOG, using TLOG URBLTDOD records. You can use these records in the CLOG file to create a sequential output file of the replicated data. For more information, read Creating a Sequential Output File.

Caution:
Be sure that the CLOG is defined in the Event Replicator Server startup JCL (via one or more DDCLOGRn DD statements) if you will be using a File destination definition during Event Replicator for Adabas processing. If you do not, a warning message will be issued and the File destination will be set to "Unavailable". For more information about the CLOG, read your Adabas documentation.

To create a File destination definition in the Adabas Event Replicator Subsystem, complete the following steps:

Step 1. Access the File Destination Definition Creation Area

Start of instruction setTo access the File destination definition creation area of the Adabas Event Replicator Subsystem:

  1. Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears.

  2. Press PF4 on the List of Destinations screen.

    The Create New Destination screen appears.

    15:34:11      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                Create New Destination                   M-RP1290  
                                                                                   
                                                                                   
                           Code    Function                                        
                           ----    -------------------------                       
                             A     Create Adabas Destination                       
                             E     Create Broker Destination                       
                             F     Create File Destination                         
                             N     Create Null Destination                         
                             M     Create MQ Destination                           
                             ?     Help                                            
                             .     Exit                                            
                            ----   -------------------------                       
                                                                                   
                   Code ...  _                                                     
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit                                                  Menu   
  3. Select option F on the Create New Destination screen.

    The File Destination Definition screen appears.

    15:42:54      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                             File Destination Definition                 M-RP1250  
                                                                                   
                       Destination Name ............. ________                     
                       Commit Threshold ........... _________0                     
                       Destination Active .................. Y                     
                       Allow Logging ....................... N                     
                       Event Logging ....................... N                     
                       Replicate Utility Changes ........... N                     
                       Open at Startup ..................... G                     
                                                                                   
                       TLOG Parms                                                  
                       ---------------------------------------                     
                       Assign Level ........................ 0                     
                       Completion Level .................... 0                     
                       SLOG Write Level .................... 0                     
                       SLOG Read Level ..................... 0                     
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save                                      Menu   

Step 2. Specify General and TLOG File Destination Parameters

Start of instruction setTo use the Adabas Event Replicator Subsystem to supply general and TLOG specifications for a File destination definition, complete the following steps:

  1. Update the following general fields on the File Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Destination Name The unique name for the File destination definition. This is the equivalent of specifying the DESTINATION NAME parameter directly in the Event Replicator Server startup job. The specified name must be alphanumeric and be between one and eight characters long. ---
    Commit Threshold The number of URBLTDOD TLOG record bytes that will be written to the CLOG sequential file before the buffers are flushed.

    For complete information on specifying a value for this parameter, read DCOMMITTHRESHOLD.

    0
    Destination Active Whether or not this destination definition should be activated for use once it is loaded by the Event Replicator Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). This is the equivalent of specifying the DACTIVE parameter in the Event Replicator Server startup job. Y
    Allow Logging 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). This is the equivalent of specifying the DLOG parameter in the Event Replicator Server startup job. N
    Event Logging Whether or not events should be logged by the Event Replicator Server and sent to this destination. This is the equivalent of specifying the DEVENTLOG parameter directly in the Event Replicator Server startup job. Valid values are "Y" or "N". When this optional parameter is set to "Y", Event Replicator Server events are logged to the destination. When this parameter is set to "N" (the default), they are not.

    Event Replicator Server events are logged in URBS elements. These URBS elements are sent to destinations related to the event itself. The URBS elements are also sent to any other destinations you have defined "Event Logging =Y". If a related destination also is defined with "Event Logging =Y", it will only receive one instance of the URBS element.

    To access this log of Event Replicator Server events in the destination queue, you must supply your own application that reads the event URBS elements in the destination queue. If such an application does not exist, the logged events simply sit in the queue.

    N
    Replicate Utility Changes Whether Adabas utility change replication should be activated for a destination at Event Replicator Server startup. This is the equivalent of specify the DREPLICATEUTI parameter directly in the Event Replicator Server startup job. Valid values are "Y" and "N".

    If "Y" is specified, utility replication is activated for the destination at Event Replicator Server startup; if "N" is specified, utility replication is not activated for the destination.

    For more information about replicating utility functions, read Replicating Utility Functions.

    N
    Open at Startup Whether or not the destination should be opened at Event Replicator 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 Event Replicator Server startup. When this parameter is set to "N", the destination is not opened at Event Replicator Server startup.

    When this parameter is set to "G", the decision to open the destination at Event Replicator Server startup depends on the setting of the Open Destinations at start (GOPEN) global parameter. If GOPEN=YES, the destination is opened at Event Replicator Server startup; if GOPEN=NO, it is not opened.

    This is the equivalent of specifying the DOPEN parameter in the Event Replicator Server startup job.

    G
  2. Update the following TLOG fields on the File Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Assign Level The level of transaction logging that should occur when a transaction is assigned to a destination for output processing. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLASSIGN parameter in the Event Replicator Server startup job. 0
    Completion Level The level of transaction logging that should occur when a transaction has been successfully output to the messaging system. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLCOMP parameter in the Event Replicator Server startup job. 0
    SLOG Write Level The level of transaction logging that should occur when a transaction has been successfully written to the SLOG file. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGWRITE parameter in the Event Replicator Server startup job. 0
    SLOG Read Level The level of transaction logging that should occur when a transaction has been successfully read from the SLOG and is about to be queued for output to the destination. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGREAD parameter in the Event Replicator Server startup job. 0

Step 3. Save the File Destination Definition

Start of instruction setTo save the File destination definition in the Replicator system file:

  • Press PF5 on the File Destination Definition screen.

    The File destination definition is saved in the Replicator system file.

Creating a Null Destination Definition

Using null destinations, data replication is tested without actually sending the data to any destination.

To create a null destination definition in the Adabas Event Replicator Subsystem, complete the following steps:

Step 1. Access the Null Destination Definition Creation Area

Start of instruction setTo access the null destination definition creation area of the Adabas Event Replicator Subsystem:

  1. Select option D from the Adabas Event Replicator Subsystem Main Menu.

    The List of Destinations screen appears.

  2. Press PF4 on the List of Destinations screen.

    The Create New Destination screen appears.

    15:34:11      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                Create New Destination                   M-RP1290  
                                                                                   
                                                                                   
                           Code    Function                                        
                           ----    -------------------------                       
                             A     Create Adabas Destination                       
                             E     Create Broker Destination                       
                             F     Create File Destination                         
                             N     Create Null Destination                         
                             M     Create MQ 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.

    17:12:32      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2017-10-23 
                             Null Destination Definition                 M-RP1240   
                                                                                    
    Destination Name ......... ________    Destination Class ............. ________ 
    Architecture ................... _2    Destination Class Parameter Data .....   
    Commit Threshold ....... _________5    ________________________________________ 
    Destination Active .............. Y    ________________________________________ 
    Allow Logging ................... N    ________________________________________ 
    Replicate Util Chgs ............. N    Heartbeat Interval ..........          0 
    Max Output Size ........ __________                                             
    Event Logging ................... Y                                             
    Open at Startup ................. G                                             
    DSTATLOG ........................ N                                             
                                                                                    
    TLOG Parms                                                                      
    -----------------------                                                         
    Assign Level ........ 0                                                         
    Completion Level .... 0                                                         
    SLOG Write Level .... 0                                                         
    SLOG Read Level ..... 0                                                         
    Command ==>                                                                     
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- 
          Help        Exit        Save                                      Menu

Step 2. Specify General and TLOG Null Destination Parameters

Start of instruction setTo use the Adabas Event Replicator Subsystem to supply general and TLOG specifications for a null destination definition, complete the following steps:

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

    Parameter Name Specify Default
    Destination Name The unique name for the null destination definition. This is the equivalent of specifying the DESTINATION NAME parameter directly in the Event Replicator Server startup job. The specified name must be alphanumeric and be between one and eight characters long. ---
    Destination Class Leave this field blank for now. It is described later in this section. ---
    Architecture The data architecture for fields in the URB* control structures sent to the destination.

    For complete information on calculating a value for this parameter, read DARC..

    2
    Destination Class Parameter Data Leave this field blank for now. It is described later in this section. ---
    Commit Threshold The number of messages that will be sent to the null destination before a commit is performed for those messages.

    For complete information on specifying a value for this parameter, read DCOMMITTHRESHOLD.

    5
    Destination Active Whether or not this destination definition should be activated for use once it is loaded by the Event Replicator Server. Valid values are "Y" (load and activate the definition) or "N" (load, but do not activate the definition). This is the equivalent of specifying the DACTIVE parameter in the Event Replicator Server startup job. Y
    Allow Logging 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). This is the equivalent of specifying the DLOG parameter in the Event Replicator Server startup job. N
    Replicate Util Chgs Whether Adabas utility change replication should be activated for a destination at Event Replicator Server startup. This is the equivalent of specify the DREPLICATEUTI parameter directly in the Event Replicator Server startup job. Valid values are "Y" and "N".

    If "Y" is specified, utility replication is activated for the destination at Event Replicator Server startup; if "N" is specified, utility replication is not activated for the destination.

    For more information about replicating utility functions, read Replicating Utility Functions.

    N
    Heartbeat Interval

    This is the equivalent of the DHBINTERVAL subparameter for the DESTINATION parameter, defined in Event Replicator Initialization parameters. It specifies the interval (in seconds) at which the heartbeat should be published to a destination. Valid values are 0 or 60 to 86400 (24 hours).

    Use this subparameter to set the interval at which heartbeat events are sent to a particular destination. Information for a heartbeat event is collected if at least Heartbeat Interval (DHBINTERVAL) seconds have passed since a heartbeat event was last sent to the destination. This heartbeat information is inserted into the replication data stream at the exit from the Event Replicator Server (destination processing).

    A value of zero (0) indicates that a heartbeat event should not be published for a particular destination.

    The Heartbeat Interval (DHBINTERVAL) subparameter is only allowed for destinations defined with DTYPE=ETBROKER, DTYPE=MQSERIES, or DTYPE=NULL.

    The DHBINTERVAL parameter is only allowed for destinations defined with DCLASS=SAGTARG.

    Note:
    The interval between creating heartbeat events may be slightly longer (e.g. 10 seconds longer) than the interval specified for this parameter.

    0
    Max Output Size The maximum output size (in bytes) for the destination. This is the equivalent of specify the DMAXOUTPUTSIZE parameter directly in the Event Replicator Server startup job. 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, DMAXOUTPUTSIZE=4K is the same as DMAXOUTPUTSIZE=4096.

    The value for this parameter will be used if it is less than or equal to the maximum output size for the Event Replicator Server (specified using the MAXOUTPUTSIZE global parameter) and less than or equal to the maximum output allowed for the messaging system queue being defined. If this value is larger than the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system, the smaller value will be used.

    A value of 0 indicates that no specific limit is set for this destination. Instead, the smaller of the MAXOUTPUTSIZE specification or the maximum output size allowed by the messaging system will be used.

    0
    Event Logging Whether or not events should be logged by the Event Replicator Server and sent to this destination. This is the equivalent of specifying the DEVENTLOG parameter directly in the Event Replicator Server startup job. Valid values are "Y" or "N". When this optional parameter is set to "Y", Event Replicator Server events are logged to the destination. When this parameter is set to "N" (the default), they are not.

    Event Replicator Server events are logged in URBS elements. These URBS elements are sent to destinations related to the event itself. The URBS elements are also sent to any other destinations you have defined "Event Logging =Y". If a related destination also is defined with "Event Logging =Y", it will only receive one instance of the URBS element.

    To access this log of Event Replicator Server events in the destination queue, you must supply your own application that reads the event URBS elements in the destination queue. If such an application does not exist, the logged events simply sit in the queue.

    N
    Open at Startup Whether or not the destination should be opened at Event Replicator 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 Event Replicator Server startup. When this parameter is set to "N", the destination is not opened at Event Replicator Server startup.

    When this parameter is set to "G", the decision to open the destination at Event Replicator Server startup depends on the setting of the Open Destinations at start (GOPEN) global parameter. If GOPEN=YES, the destination is opened at Event Replicator Server startup; if GOPEN=NO, it is not opened.

    This is the equivalent of specifying the DOPEN parameter in the Event Replicator Server startup job.

    G
    DSTATLOG

    Decides whether or not the associated destination should receive interval statistics published by the Event Replicator Server. This parameter is used with Replication Monitoring. Valid values are Y or N (YES or NO).

    A value of Y indicates that interval statistics should be published to the destination; a value of N indicates they should not.

    A destination defined with DSTATLOG=Y cannot be specified in a subscription.

    N
  2. Update the following TLOG fields on the Null Destination Definition screen as described in the following table.

    Parameter Name Specify Default
    Assign Level The level of transaction logging that should occur when a transaction is assigned to a destination for output processing. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLASSIGN parameter in the Event Replicator Server startup job. 0
    Completion Level The level of transaction logging that should occur when a transaction has been successfully output to the messaging system. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLCOMP parameter in the Event Replicator Server startup job. 0
    SLOG Write Level The level of transaction logging that should occur when a transaction has been successfully written to the SLOG file. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGWRITE parameter in the Event Replicator Server startup job. 0
    SLOG Read Level The level of transaction logging that should occur when a transaction has been successfully read from the SLOG and is about to be queued for output to the destination. Valid values are "0" (no logging), "1" (log event and output transaction data), "2" (log event, output transaction, and file/record data), or "3" (log event and all available output information for the event). This is the equivalent of specifying the DTLSLOGREAD parameter in the Event Replicator Server startup job. 0

Step 3. (Optional) Specify Destination Class Information, If Applicable

The Destination Class and Destination Class Parameter Data fields can be used to invoke and pass parameters to the Event Replicator Target Adapter for this destination. The fields are located at the right of the null destination screen. Do not use these fields unless you want to invoke and pass parameters to the Event Replicator Target Adapter for the destination or unless otherwise requested by a Software AG support representative.

If applicable, use the Destination Class (DCLASS) field to specify the destination class for this destination definition. Valid values are blank or "SAGTARG" (if Event Replicator Target Adapter processing should be invoked). There is no default.

Note:
DCLASS=SAGTARG cannot be specified for destinations with DTYPE=ADABAS or FILE. It is only valid for webMethods EntireX, WebSphere MQ, or NULL destinations. When DCLASS=SAGTARG is specified, the ADARUN RPLPARMS parameter must be set to "FILE" or "BOTH" to provide access to any field table (GFFT) definitions.

If you specify a value for the Destination Class field, you can optionally use the Destination Class Parameter Data (DCLASSPARM) field to specify up to 120 bytes of character data to be passed to the optional destination output user exit.

If either DCLASS=SAGTARG or DCLASS=SAGTRGB is specified to invoke support for the Event Replicator Target Adapter, you may want to specify one or more of the following keyword parameters:

Note:
These parameter keywords must be specified in uppercase.

ADA

The ADA keyword is available for use with the SAGTARG DCLASS exit.

Specify the ADA keyword in the DCLASSPARM parameter if the target of the destination requires the Adabas 2-byte short name be included with the schema for all fields.

NOSPRE

The NOSPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

Specify the NOSPRE keyword in the DCLASSPARM parameter if you do not want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter. When NOSPRE is specified, the schema file name (Predict view name) alone is used for the table names; when NOSPRE is not specified, the subscription name prefixes the schema file name in the table names.

Note:
Oracle identifiers are limited to 30 characters. If NOSPRE is not specified and an Oracle RDBMS is used by the Event Replicator Target Adapter, the identifier names may exceed 30 characters and errors may occur. We recommend using NOSPRE if an Oracle RDBMS is also used.

SPRE

Specify the SPRE keyword in the DCLASSPARM parameter if you do want the subscription name to prefix the names of the tables produced by the Event Replicator Target Adapter.

The notation is SPRE=xxxxxxxx. Where xxxxxxxx can be a subscription prefix to be used instead of the subscription name used in the job execution. The prefix can be 1 to 8 characters in size.

The SPRE keyword is available for use with both SAGTARG and SAGTRGB DCLASS exits.

OPTIONS

The OPTIONS keyword parameter can be used to specify options for the destination. Specify the OPTIONS keyword parameter, using the syntax OPTIONS=nnnn. Possible values of the OPTIONS (nnnn) are listed in the following table. However, if you want to combine options, add their values together and enter the total value.

For example, if you want to combine option 32 (to send the full image on an update) and option 64 (to set the XML transaction committed time value to local time instead of GMT/UTC), specify OPTIONS=96 (with 96 being the sum of 32 and 64).

Option Value Description
1 Specify OPTIONS=1 to send the full image on an insert.
2 Specify OPTIONS=2 to indicate that long names should be used. This option will cause long names to be sent in place of the default short names used for various elements and attributes. Short names are the default and save on the amount of data being transferred. Long names make for better readability. For example, the short name <F> would appear as <Field> using long names.
4 Specify OPTIONS=4 to ensure that invalid XML characters found in alphanumeric fields are not translated to spaces.
8 Specify OPTIONS=8 to ensure that trailing blanks in alphanumeric fields are not removed.
16 Specify OPTIONS=16 to ensure that characters used by XML are not replaced automatically with predefined entity references. For example, if OPTIONS=16 is set, the ampersand (&) character would not be replaced with the literal "&amp;".
32 Specify OPTIONS=32 to send the full image on an update. The full before image (if available) and after image of all fields are sent for an update and insert, even if the field values were not changed or are null.

Note:
This option is mutually exclusive with option 128. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

64 Specify OPTIONS=64 to set the XML transaction committed time value to local time instead of GMT/UTC.
128 Specify OPTIONS=128 if the before image is not to be included when a field is updated/changed if the before image data storage records are included. Primary field before images will still be included because the key is needed to find the record that is to be changed.

Note:
This option is mutually exclusive with option 32. If both options are specified, then OPTIONS=32 will be set and OPTIONS=128 ignored.

256 Specify OPTIONS=256 to suppress ARMXL004I information messages.
TRACE

The TRACE keyword parameter can be used to specify the contents of the trace. Specify the TRACE keyword parameter using the syntax TRACE=nnnn. Possible values of the TRACE (nnnn) are listed in the following table. However, if you want to trace multiple control blocks, add their trace values together and enter the total value. For example, to trace the before and after images of the URBD control blocks, you would specify TRACE=24 because the sum of 8 (URBD control block before image) and 16 (URBD control block after image) is 24.

Note:
If tracing is enabled using this keyword parameter, be sure to include the following JCL statement in the startup JCL of the Event Replicator Server:
//DDTRACE1 DD SYSOUT=X

Settings for DCLASS=SAGTARG

Trace Value Description
1 Trace the URBS control block.
2 Trace the URBT control block.
4 Trace the URBR control block.
8 Trace the URBD control block before image.
16 Trace the URBD control block after image.
32 Trace the URBF/URBG control block before image.
64 Trace the URBF/URBG control block after image.
128 Trace the send buffer.
256 Trace the URBY control block.
512 Trace the URBO control block.
1024 Trace the output parameters.
2048 Trace the subscription table.

Settings for DCLASS=SAGTRGB

Trace Value Description
1 Trace the output buffer.
2 Trace the URBD control block after image.
4 Trace the URBR control block.
8 Trace the URBT control block.
16 Trace the URBH control block.
32 Trace the URBF/URBG control block before image.
64 Trace the URBS control block.
128 Trace the URBY control block.
256 Trace the URBO control block.
512 Trace the URBD AI control blocks
1024 Trace the URBF/G AI control blocks
2048 Trace the subscription table.

Step 4. Save the Null Destination Definition

Start of instruction setTo save the null destination definition in the Replicator system file:

  • Press PF5 on the Null Destination Definition screen.

    The null destination definition is saved in the Replicator system file.

Modifying Destination Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to modify a destination definition in the Replicator system file:

  1. List the destination definition in the Adabas Event Replicator Subsystem, as described in Listing Destination Definitions.

    The destinations are listed on the List of Destinations screen.

  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 name of the definition to which the list should be repositioned.

    An appropriate destination definition screen appears for the destination type you selected. For information on modifying this screen, read the description of adding that type of destination definition, elsewhere in this section.

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

Copying Destination Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to copy a destination definition in the Replicator system file:

  1. List the destination definition in the Adabas Event Replicator Subsystem, as described in Listing Destination Definitions.

    The destinations are listed on the List of Destinations screen.

  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 name of the definition to which the list should be repositioned.

    A dialog appears requesting a name for the copy of the destination definition.

                                  
     Enter new name: ________     
     or press PF3 to cancel       
                                  
  3. Specify a new, unique name 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.

Activating and Deactivating Destination Definitions

You can use Adabas Online System (AOS) to activate and deactivate destination definitions. For more information, read Activating and Deactivating Replication Definitions and Databases

Warning:
Be careful when you activate and deactivate replication definitions and databases, especially if replication is ongoing at the time. Whenever you activate or deactivate definitions or databases, you run the risk of altering what data is replicated and how that replication occurs. If the Event Replicator Server receives data from an Adabas database for which it has no active definitions, replication simply does not occur.

Deleting Destination Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to delete a destination definition in the Replicator system file:

  1. List the destination definition in the Adabas Event Replicator Subsystem, as described in Listing Destination Definitions.

    The destinations are listed on the List of Destinations screen.

  2. Locate the definition you want to delete on the screen and enter a D 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 name of the definition to which the list should be repositioned.

    The destination definition is deleted.