An SFILE definition defines the Adabas file containing the input data to be processed by the subscription. SFILE definitions are included within subscription definitions. They include format buffer specifications for the file data (they can reference GFB definitions instead). SFILE definitions may also specify a transaction filter definition that should be applied to the data in the SFILE file and a subscription user exit that should be used in processing the file data.
At least one SFILE definition is required in a subscription definition for every Event Replicator for Adabas run.
This document covers the following topics:
To use the Adabas Event Replicator Subsystem to list the SFILE definitions stored in a
subscription:
Select option from the Adabas Event Replicator Subsystem Main Menu.
The Available Subscriptions screen appears showing all of the subscription definitions in the Adabas Event Replicator Subsystem.
18:32:30 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
Available Subscriptions M-RP1400
Sel Name Ver Description
--- -------- --- ---------------------------------
_ SI040155 OC INITIAL STATE 040 155
_ SI042060 OC INITIAL STATE 042 060
_ SI042200 OC INITIAL STATE 042 200
_ SI046088 OC INITIAL STATE 046 088
_ SI062026 OC INITIAL STATE 062 026
_ SI062029 OC INITIAL STATE 062 029
_ SI062035 OC INITIAL STATE 062 035
_ SI062055 OC INITIAL STATE 062 055
_ SI062079 OC INITIAL STATE 062 079
_ SI062106 OC INITIAL STATE 062 106
_ SI062143 OC INITIAL STATE 062 143
_ SI064121 OC INITIAL STATE 064 121
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. |
Enter an M in the Sel column corresponding to the Adabas subscription definition containing the SFILE definitions you want to list.
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.
You are prompted to select the version of the subscription definition containing the SFILE definitions. The following is a sample pop-up menu from which you can select the version.
Please Choose Version
Code Version
---- ------------
C Current
S Scheduled
---- ------------
Code ... _
|
Select the version by entering the appropriate code in the Code field.
The Subscription Definition screen appears listing the details of the Adabas subscription.
Tab down to the File-related Parameters field on the Subscription Definition screen and enter an "S".
The List of Subscription SFILEs screen appears listing the SFILE definitions currently defined in the Adabas subscription definition.
18:32:30 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
List of Subscription SFILEs M-RP1415
Current
User BI AI KR
Sel DBID File Ins Upd Del Exit FB FB FB
-----------------------------------------------------
_ 1955 1 Y Y Y + +
_ 1955 2 Y Y Y + +
_ 1955 3 Y Y Y + +
_
_
_
_
_
_
_
_
_
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Add - + Menu |
To add an SFILE definition to a subscription, complete the steps described in this section:
To access the SFILE definition area of a subscription
definition:
Select option from the Adabas Event Replicator Subsystem Main Menu.
The Available Subscriptions screen appears showing all of the subscription definitions in the Adabas Event Replicator Subsystem.
18:32:30 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
Available Subscriptions M-RP1400
Sel Name Ver Description
--- -------- --- ---------------------------------
_ SI040155 OC INITIAL STATE 040 155
_ SI042060 OC INITIAL STATE 042 060
_ SI042200 OC INITIAL STATE 042 200
_ SI046088 OC INITIAL STATE 046 088
_ SI062026 OC INITIAL STATE 062 026
_ SI062029 OC INITIAL STATE 062 029
_ SI062035 OC INITIAL STATE 062 035
_ SI062055 OC INITIAL STATE 062 055
_ SI062079 OC INITIAL STATE 062 079
_ SI062106 OC INITIAL STATE 062 106
_ SI062143 OC INITIAL STATE 062 143
_ SI064121 OC INITIAL STATE 064 121
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Repos Exit Add - + Menu |
Enter an M in the Sel column corresponding to the Adabas subscription definition to which you want to add an SFILE 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.
You are prompted to select the version of the subscription definition containing the SFILE definitions. The following is a sample pop-up menu from which you can select the version.
Please Choose Version
Code Version
---- ------------
C Current
S Scheduled
---- ------------
Code ... _
|
Select the version by entering the appropriate code in the Code field.
The Subscription Definition screen appears listing the details of the Adabas subscription.
18:33:00 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
Subscription Definition M-RP1410
Description .................. ________________________________
Subscription Name ............. ________ TLOG Values
User Data Alpha Key ........... ___0 ------------------------
Architecture Key .............. ___2 Input Level .......... 0
Subscription Version .......... __ Filter Level ......... 0
User Data Wide Key ............ ___0 Output Level ......... 0
Resend Buffer Name ............ ________ Filter Matched ....... 0
Filter Not Matched ... 0
Destination Name List ......... _ Filter Ignored ....... 0
File-related Parameters ....... _
Incomplete Item(s)
Subscription Active ........... Y ------------------
Deactivate if file deactivated Y Destination
Increment Initial State Count N File-Related Parms
Format Buffer
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Save Menu |
Tab down to the File-related Parameters field on the Subscription Definition screen and enter an "S" for the field.
The List of Subscription SFILEs screen appears listing the SFILE definitions currently defined in the Adabas subscription definition.
18:32:30 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
List of Subscription SFILEs M-RP1415
Current
User BI AI KR
Sel DBID File Ins Upd Del Exit FB FB FB
-----------------------------------------------------
_ 1955 1 Y Y Y + +
_ 1955 2 Y Y Y + +
_ 1955 3 Y Y Y + +
_
_
_
_
_
_
_
_
_
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Add - + Menu |
Press PF4 to start adding a new SFILE definition.
The File-Related Parameters screen appears.
18:39:04 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2013-02-28
File-Related Parameters M-RP1420
Description .................. INITIAL STATE 040 155
Subscription Name ............ SI040155 Current
DBID ......................... _____
File Number ................ ____
Replicate for Insert ....... Y
Replicate for Update ....... Y
Include Identical Records .. Y
Replicate for Delete ....... Y
Replicate Security File .... N Transaction Filter ...... * ________
Subscription User Exit ..... ________ Filter Before Image FB .. * _______
Default Code ............... ____ Filter After Image FB ... * _______
Before Image FB ............ _ -or- Before Image GFB Name . * _______
After Image FB ............. _ -or- After Image GFB Name .. * _______
Key-Related Before Image FB _ -or- Key-Related GFB Name .. * _______
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Save Sel Menu |
To specify the information in the SFILE definition of a
subscription:
Update the fields on the File-Related Parameters screen as described in the following table.
| Parameter Name | Specify | Default |
|---|---|---|
| Description | The description of the subscription to which this SFILE definition applies. You cannot change this field here. | ---- |
| Subscription Name | A unique name for the subscription. You cannot change this field here. | --- |
| DBID | The database ID associated with the input file specified by this SFILE definition. The database ID is numeric and can range from one through 65535. This is the same as specifying the SFDBID parameter directly in the Event Replicator Server startup job. | --- |
| File Number | The number of the input file to be processed by this SFILE definition. This is the equivalent of specifying the SFILE parameter directly in the Event Replicator Server startup job. | --- |
| Replicate for Insert | Whether or not you want records
from this Adabas file replicated when they are inserted. Specify
"Y" if you want them replicated or
"N" if you do not want them replicated.
This is the same as specifying the SFREPLICATEINSERT parameter in the Event Replicator Server startup job. |
Y |
| Replicate for Update | Whether or not you want records
from this Adabas file replicated when they are updated. Specify
"Y" if you want them replicated or
"N" if you do not want them replicated.
This is the same as specifying the SFREPLICATEUPDATE parameter in the Event Replicator Server startup job. |
Y |
| Include Identical Records | Whether an update request should be replicated if the after image (AI) is the same as the before image (BI). Valid values are "Y" or "N". If "Y" is specified and the before and after images are the same, the record is replicated subject to other field filtering that may be specified for this file. If "N" is specified, and the before and after images are the same, no further processing occurs for the record. Note that the format buffers for the before and after images must be identical. This is the same as specifying the SFREPLICATENOTCHANGED parameter in the Event Replicator Server startup job. | Y |
| Replicate for Delete | Whether or not you want records
from this Adabas file replicated when they are deleted. Valid values are
"Y" (Yes), "N" (No), or
"U" (Update).
This is the same as specifying the SFREPLICATEDELETE parameter in the Event Replicator Server startup job. If this parameter is set to "N" and an input record for the DBID/file is for a delete, the input record will NOT be processed for this subscription. If this parameter is set to "Y" and an input record for the DBID/file is for a delete, the input record will be processed for this subscription. If this parameter is set to "U" and an input record for the DBID/file is for a delete, the before and after images of the input record are passed to your subscription user exit. Therefore, if this parameter is set to "U", a subscription user exit name must be specified in the Subscription User Exit parameter. In addition, the subscription before and after image format buffers must be identical and no primary key should be defined to the file (to ensure that the before image is a copy of data storage). The purpose of the "U" value of this parameter is to allow your subscription user exit to process replicated physical delete transactions on your target database as you choose. Your subscription user exit can decide if the physical delete transaction should be: physically deleted from your target database, converted to an update, or ignored and not sent at all. For more information about using the subscription user exit with the "U" setting of this parameter, read Controlling Delete Transaction Processing (SFREPLICATEDELETE=UPDATE Processing). |
Y |
| Replicate Security File | Whether or not you want security
definitions in the Adabas security file replicated. Valid values are
"Y" or "N", with a
default of "N". The setting of this parameter allows
you to define a subscription file (SFILE) definition specifically for security
definitions in the Adabas security file on the database.
Notes:
When this parameter is set to "N", replication of the security definitions does not occur and replication processing proceeds normally. When this parameter is set to "Y", replication of the security definitions in the Adabas security file will occur. However, the following parameter settings are also required:
This is the same as specifying the SFSECURITYFILE parameter in the Event Replicator Server startup job. For complete information about replicating security definitions, read Replicating Security Definitions. |
N |
| Subscription User Exit | The name of the
subscription user exit you
want used (if any) when records from the file specified by this SFILE
definition are replicated. This is the same as specifying the
SFSEXIT parameter in the Event Replicator Server
startup job.
For more information about subscription user exits, read Using the Event Replicator Server Subscription User Exit. |
--- |
| Default Code | A default, at the subscription
file level, for the file’s alpha character encoding. The encoding must belong
to the EBCDIC encoding family; that is, the space character must be X’40’.’.
This can only be set when the Event Replicator Server has been started with Universal Encoding
Support (UES) enabled.
This parameter is meant to be used when all of the following conditions are met:
At the time a before or after image is decompressed and translated in the Event Replicator Server, the file encoding is taken as follows:
Note that if the source database is UES-enabled, the file encoding will be taken from either a or b above. This is the equivalent of specifying the SFDEFAULTACODE parameter directly in the Event Replicator Server startup job. |
none |
| Transaction Filter | The name of the transaction
filter definition you want used (if any) when records from the file specified
by this SFILE definition are replicated. This is the equivalent of specifying
the SFFILTER parameter directly in the
Event Replicator Server startup job. Press the PF6 key while the cursor is on this field to
pick a definition from a list.
Note: |
--- |
| Filter Before Image FB | The name of a predefined
GFB definition containing the format
buffer to be used when filtering the data storage before image as described by
the SFFILTER parameter. For more information about GFB definitions, read
Maintaining GFB
Definitions
Ordinarily this parameter is optional. It is only required if both of the following conditions are met:
This is the equivalent of specifying the SFFILTERGFBBI parameter directly in the Event Replicator Server startup job. This parameter can be used to improve the performance of Event Replicator processing. For example, if most records for a large format buffer are being rejected due to a filter based on the contents of a small number of fields, it may help to specify the key fields in a filter format buffer so that, for most records, only the fields required to make acceptance/rejection decisions are decompressed instead of the entire buffer. |
--- |
| Filter After Image FB | The name of a predefined
GFB definition containing the format
buffer to be used when filtering the data storage after image as described by
the SFFILTER parameter. For more information about GFB definitions, read
Maintaining GFB
Definitions.
Ordinarily this parameter is optional. It is only required if both of the following conditions are met:
This is the equivalent of specifying the SFFILTERGFBAI parameter directly in the Event Replicator Server startup job. This parameter can be used to improve the performance of Event Replicator processing. For example, if most records for a large format buffer are being rejected due to a filter based on the contents of a small number of fields, it may help to specify the key fields in a filter format buffer so that, for most records, only the fields required to make acceptance/rejection decisions are decompressed instead of the entire buffer. |
--- |
| Before Image FB | An "S"
to specify the format buffer to be used when decompressing the data storage
before image. The Before Image FB screen appears on
which you can specify the format buffer. This format buffer specification is
saved in the SFILE definition.
Format buffer specifications on the Before Image FB screen must conform to the format buffer rules (for read commands) described in the Adabas Command Reference. Be sure to press PF5 to save the format buffer specifications. Then press PF3 to return to the File-Related Parameters screen. PE and MU fields cannot use the range notation 1-N in format buffers for a subscription that is sent to a destination that has specified the replication intialization parameter DCLASS=SAGTARG. The SAGTARG application invoked requires that the range of occurrences specified are contained in the record buffer even if they are empty occurrences. 1-N results in a range of 1-191, but unless there are 191 occurrences containing data, space in the record buffer is not allocated for any empty occurrences, resulting in incorrect field positioning when processing the record. Note: This is the same as specifying the SFBBI parameter directly in the Event Replicator Server startup job. |
The after-image format buffer or GFB is used if no before image format buffer or GFB are specified. |
| Before Image GFB Name | The name of a predefined
GFB definition containing the format
buffer to be used when decompressing the data storage before image. For more
information about GFB definitions, read Maintaining GFB
Definitions.
Note: This is the equivalent of specifying the SGFORMATBI parameter directly in the Event Replicator Server startup job. If you are using the Event Replicator Target Adapter (if
"SAGTARG" is
specified as the destination
class of some destination used by this subscription), the value used
for the |
The after-image format buffer or GFB is used if no before image format buffer or GFB are specified. |
| After Image FB | An "S"
to specify the format buffer to be used when decompressing the data storage
after image. The After Image FB screen appears on
which you can specify the format buffer. This format buffer specification is
saved in the SFILE definition.
Format buffer specifications on the After Image FB screen must conform to the format buffer rules (for read commands) described in the Adabas Command Reference. Be sure to press PF5 to save the format buffer specifications. Then press PF3 to return to the File-Related Parameters screen. PE and MU fields cannot use the range notation 1-N in format buffers for a subscription that is sent to a destination that has specified the replication intialization parameter DCLASS=SAGTARG. The SAGTARG application invoked requires that the range of occurrences specified are contained in the record buffer even if they are empty occurrences. 1-N results in a range of 1-191, but unless there are 191 occurrences containing data, space in the record buffer is not allocated for any empty occurrences, resulting in incorrect field positioning when processing the record. Note: Caution: This is the same as specifying the SFBAI subparameter in the Event Replicator Server startup job. |
No default. A value for this field or the After Image GFB Name field is required. |
| After Image GFB Name | The name of a predefined
GFB definition containing the format
buffer to be used when decompressing the data storage after image. For more
information about GFB definitions, read Maintaining GFB
Definitions.
Note: Caution: This is the same as specifying the SGFORMATAI parameter in the Event Replicator Server startup job. If you are using the Event Replicator Target Adapter (if
"SAGTARG" is
specified as the destination
class of some destination used by this subscription), the value used
for the |
No default. A value for this field or the After Image FB field is required. |
| Key-Related Before Image FB | An "S"
to specify the format buffer to be used when decompressing the key-related
before image. The Key-Related FB screen appears on
which you can specify the format buffer. This format buffer specification is
saved in the SFILE definition.
Format buffer specifications on the Key-Related FB screen must conform to the format buffer rules (for read commands) described in the Adabas Command Reference. Be sure to press PF5 to save the format buffer specifications. Then press PF3 to return to the File-Related Parameters screen. Note: This is the same as specifying the SFBKEY parameter directly in the Event Replicator Server startup job. |
The field name followed by a period will be used as a default for this format buffer. |
| Key-Related GFB Name | The name of a predefined GFB
definition containing the format buffer to be used when decompressing the
key-related before image. For more information about GFB definitions, read
Maintaining GFB
Definitions.
Note: This is the equivalent of specifying the SGFORMATKEY parameter directly in the Event Replicator Server startup job. If you are using the Event Replicator Target Adapter (if
"SAGTARG" is
specified as the destination
class of some destination used by this subscription), the value used
for the |
The field name followed by a period will be used as a default for this format buffer. |
Press PF5 to save the SFILE definition.
To save the SFILE definition:
Press PF5 to save the SFILE definition in the subscription definition in the Replicator system file.
To use the Adabas Event Replicator Subsystem to modify an SFILE definition in a
subscription:
List the subscription definitions in the Adabas Event Replicator Subsystem, as described in Listing SFILE Definitions.
The SFILE definitions are listed on the List of Subscription SFILEs screen.
Locate the definition you want to modify on the screen and enter an M in the Sel column for that definition.
The File-Related Parameters screen appears listing file-related parameters for the Adabas subscription. For information on modifying this screen, read the description of Adding SFILE Definitions.
When all modifications have been made, press PF5 to save the changes.
The SFILE modification is complete.
To use the Adabas Event Replicator Subsystem to delete an SFILE definition in a
subscription:
List the SFILE definitions in the Adabas Event Replicator Subsystem, as described in Listing SFILE Definitions.
The SFILE definitions are listed on the List of Subscription SFILEs screen.
Locate the definition you want to delete on the screen and enter a D in the Sel column for that definition.
The SFILE definition is deleted.