A GFB definition defines a global format buffer (GFB) stored separately for reference in SFILE definitions. GFB definitions can be used to decompress replicated data from a specific database file for one or more subscriptions.
While a format buffer specification is required in a subscription's SFILE definition, a stored GFB definition does not need to be used. The SFILE definition could simply include the format buffer specifications it needs.
Notes:
Using the Adabas Event Replicator Subsystem you can manually add, modify, and delete GFB definitions. If you have Predict 4.4.1 with Service Pack 3 (or higher) installed, you can also generate a GFB. If this version of Predict is not installed, you will not be able to use this feature.
This document covers the following topics:
To use the Adabas Event Replicator Subsystem to list the general format buffer (GFB)
definitions stored in the Replicator system file:
Select option from the Adabas Event Replicator Subsystem Main Menu.
The List of Global Format Buffers screen appears showing all of the GFB definitions in the Adabas Event Replicator Subsystem.
10:09:23 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2007-06-02
List of Global Format Buffers M-RP1130
Sel Name Sel Name Sel Name Sel Name
------------ ------------ ------------ ------------
_ GFBNAME _ _ _
_ TSTGFB _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
_ _ _ _
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Gen Quit Add - + Exit |
You can add global format definitions by typing in the format buffer definition manually or using Predict to generate one for you. This section describes how to add one manually.
To use the Adabas Event Replicator Subsystem to add a global format definition manually:
Select option from the Adabas Event Replicator Subsystem Main Menu.
The List of Global Format Buffers screen appears.
Press the PF4 function key.
The Global Format Buffer screen appears.
10:09:51 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2007-06-02
Global Format Buffer M-RP1120
GFB Name .. _______ Predict Parameters .. _
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
____________________________________________________________________________
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Quit Mode Save - + Exit |
Tab to the GFB Name field and specify a unique name for the global format buffer definition. The name must be between one and seven characters long.
Note:
If, at this point, you want to generate the GFB and field table,
rather than enter it manually, enter an "S" in the
Predict Parameters field. The Predict
Parameters screen appears. For more information about generating a
GFB, skip the rest of the documentation in this section and read
Generating a
GFB.
If the destination target for replicated data is an Adabas mainframe database running Adabas 8.1.3 or later, you can specify the symbolic notation "C." alone as the global format buffer. This notation will cause the Event Replicator Server to replicate the entire source record to the target mainframe Adabas database.
Caution:
This "C." option may be used
only if the destination target file has been defined with the same
fields in the same order as the fields in the source file; if there are
differences in the definitions of the files, the replication of the data is
likely to incur errors. The only exception to this rule is that the definitions
of the descriptors and superdescriptors in the target and source files may be
different.
Use the blank lines below the GFB Name field to manually specify the format buffer for this definition. The format buffer must conform to the format buffer requirements (for read commands) documented in the Adabas command reference documentation.
Use the PF7 and PF8 keys to scroll backwards and forwards through the format buffer definition.
Press PF5 to save the GFB definition.
If you have Predict 4.4.1 with Service Pack 3 (or higher) installed, you can now generate format buffers and corresponding field tables from Predict file definitions using the Adabas Event Replicator Subsystem. If this version of Predict is not installed, you will not be able to use this feature.
Notes:
To use the Adabas Event Replicator Subsystem to generate global format buffer definition using
Predict:
Select option from the Adabas Event Replicator Subsystem Main Menu.
The List of Global Format Buffers screen appears.
Press the PF2 function key.
The Predict Parameters screen appears.
11:05:13 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2007-06-15
FDIC=(54,25) Predict Parameters M-RP1121
GFB Name .......... GFBNAME
File ID ......... * ________________________________
Target file ID .. * ________________________________
---------- Generation Information ----------
User ..............
Date ..............
Time ..............
FDIC .............. DBID .. FNR ..
Adabas version ....
Occurrences used ..
Full format .......
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Exec Pick Unlnk Menu |
Update the following fields on this screen as described in this table.
| Parameter Name | Specify | Default |
|---|---|---|
| File ID | The name of a Predict file with a file type or
Adabas (A) or Adabas user view (U).
Place your cursor on this field and press PF6 to select a file from a List of Predict Files screen. To select from the list screen, type an "S" next to the file you want to use and press PF5. |
--- |
| GFB Name | A unique name for the global format buffer definition. The name must be between one and seven characters long. | --- |
| Target file ID | The name of a Predict file with a file type of
sequential (S). This file may be used to insert space notation (nX) into the
format buffer. For fields in the target file with matching definitions in the
File ID file (in other words, if a field exists with the same field long name),
a short name clause is generated. For fields that do not have a matching
definition in the File ID file, an appropriate space notation (nX clause) is
generated. The spaces defined by nX clauses can be filled using a user exit.
Place your cursor on this field and press PF6 to select a file from a List of Predict Files screen. To select from the list screen, type an "S" next to the file you want to use and press PF5. |
--- |
When you first create a definition, the remaining fields on this screen are blank. However, when you modify the definition later, they are filled in, although you cannot modify them. These display-only fields are described in the following table:
| Parameter Name | Displays |
|---|---|
| Adabas version | The version of Adabas for which the global format buffer was generated. |
| Date | The date the global format buffer was generated. |
| FDIC (top of the screen) | The current database and file number of the Predict file. |
| FDIC...DBID...FNR | The database and file number of the Predict file. |
| Full format | Whether the full format buffer was generated. The full format buffer includes the length and format of Adabas fields. A value of "Y" indicates that the full format buffer was generated; a value of "N" indicates it was not. |
| Occurrences used | How multiple occurrences of PE and MU fields
are generated in the GFB and resulting field table. A value of
"M" indicates that the maximum number of occurrences
should be generated (191); a value of "N" indicates
that no occurrences will be generated; a value of
"Y" indicates that the number of occurrences defined
by the Predict Occ attribute should be
generated.
|
| Time | The time of day the global format buffer was generated. |
| User | The user ID of the user who generated the global format buffer. |
When you have supplied values for the File ID, GFB Name, and Target file ID fields, press PF5 to start generating the global format buffer.
A small window appears requesting more information.
+-----------------------------+ ! Adabas Version ...* I7 ! ! Occurrences used..* Y ! ! Full format ....... Y (Y/N) ! +-----------------------------+ |
Update the fields on this screen as described in the following table:
| Parameter Name | Specify | Default |
|---|---|---|
| Adabas Version | The version of Adabas for which the global format buffer will be generated. The version should be expressed as "I7" or "R7". If you want special fields and descriptors included in the generated GFB and corresponding field tables, specify "R7". | I7 |
| Full format | You cannot edit this parameter. It indicates that the full format buffer should be generated. | Y |
| Occurrences used | How multiple occurrences of PE and MU fields
are generated in the GFB. A value of "M" indicates
that the maximum number of occurrences should be generated (191); a value of
"N" indicates that no occurrences will be generated;
a value of "Y" indicates that the number of
occurrences defined by the Predict Occ attribute
should be generated.
|
Y |
When these fields are set to your liking, press ENTER.
The global format buffer definition and field table are generated and the Global Format Buffer screen appears.
09:13:10 ***** A D A B A S EVENT REPLICATOR SUBSYSTEM ***** 2007-06-21
Global Format Buffer M-RP1122
GFB Name .. MYGFB__ Predict Parameters .. _ + 1 of 5
Ty L Field ID F Cs Length R K Format Buffer
MU 1 MU-FIELD-WITH-COUNTER(1-30) P 3.2 _ _ AB1-30,3,P
1 SPACE A 9.0 _ _ 9X
PE 1 PE-GROUP
2 FIELD1-IN-PE(1-2) A 2.0 _ _ AD1-2,2,A
2 FIELD2-IN-PE(1-2) A 3.0 _ _ AE1-2,3,A
Command ==>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Mode Save - + Menu |
Note:
SQL Significance Indicator fields are marked with an
"_S" in the Ty field (field
type column).
Optionally, modify the Cs, R, and K settings for the fields, as described in the following table:
| Setting | Valid Values | Description |
|---|---|---|
| Cs | "C" or blank | This setting indicates whether or not the
field content should be converted to character format in the destination user
exit. The Cs setting is only modifiable for non-counter fields in binary format
with lengths of 1-8 characters. Valid values are C (convert to the field
content to character) or blank (do not convert the field content).
Note: |
| R | "Y" or blank | This setting indicates whether or not the
field is read-only. Read-only fields are not replicated. A value of
"Y" indicates that the field is read-only (not
replicated); a blank value indicates that the field is not read-only and is
replicated.
Note: |
| K | "D", "P", "U", or blank | This setting indicates the kind of key field
that the field represents. Possible values are:
Notes:
|
Once all changes are made, press PF5 to save the generated global format buffer definition.
To use the Adabas Event Replicator Subsystem to modify a global format buffer (GFB) definition
in the Replicator system file:
List the GFB definitions in the Adabas Event Replicator Subsystem, as described in Listing GFB Definitions.
The GFB definitions are listed on the List of Global Format Buffers screen.
Locate the definition you want to modify on the screen and enter an M in the Sel column for that definition.
The Global Format Buffer screen for the GFB you selected appears .
Manually modify the GFB definition on this screen.
For information on manually modifying this screen, read the description of Adding GFB Definitions.
Or:
If the Predict Parameters field has a plus (+)
symbol next to it, the GFB was originally generated by the Adabas Event Replicator Subsystem. Enter an
"S" in the Predict Parameters
field to regenerate the GFB on the Predict Parameters
screen. For information about generating a GFB, read
Generating a
GFB
When all modifications have been made, press PF5 to save the changes.
If a GFB definition has been generated from Predict and it has been saved, you can unlink the Predict generation information from the generated GFB definition.
To use the Adabas Event Replicator Subsystem to unlink the Predict generation information from
the GFB:
Access the GFB definition, as described in Modifying GFB Definitions. Be sure to enter an "S" in the Predict Parameters field of the Global Format Buffer screen. This will allow you to access the Predict Parameters screen for that GFB.
Once the Predict Parameters screen associated with the GFB appears, click PF7 to unlink the Predict generation information from the GFB.
The Global Format Buffer screen appears.
Press PF5 to save the GFB definition.
To use the Adabas Event Replicator Subsystem to copy a global format buffer (GFB) definition in
the Replicator system file:
List the GFB definitions in the Adabas Event Replicator Subsystem, as described in Listing GFB Definitions.
The GFB definitions are listed on the List of Global Format Buffers screen.
Locate the definition you want to copy on the screen and enter a C in the Sel column for that definition.
A dialog appears requesting a name for the copy of the GFB definition.
Enter new name: ________
or press ENTER to cancel
|
Specify a new, unique name for the copy of the GFB definition and press Enter.
The GFB definition is copied and the copy appears on the List of Global Format Buffers screen.
To use the Adabas Event Replicator Subsystem to delete a global format buffer (GFB) definition
in the Replicator system file:
List the GFB definitions in the Adabas Event Replicator Subsystem, as described in Listing GFB Definitions.
The GFB definitions are listed on the List of Global Format Buffers screen.
Locate the definition you want to delete on the screen and enter a D in the Sel column for that definition.
The GFB definition is deleted.
