Writer instructions

Purpose

Use this page to display a banner announcement on each page of the space. Create the Space announcements page in the master space, outside of the Home branch.

You can version the Space announcements page to enable different banners to be published into different target spaces, however, the banner that is displayed in the versioned (master) space itself only displays the most recently-published banner.  If you find errors in the banner area of your versioned space and you are sure the Space announcements page is set up correctly, try publishing the page to the same space.

For more information, see Space-announcements-banners.

Removing

When an announcement is no longer needed, remove the BMC Space Banner macro.

Translation

Localized spaces using the L10n Viewport theme must change the name of this page to Space announcements l10n.  See Configuring-the-Scroll-ViewPort-theme-for-translated-spaces.

Usage

Choose one or none of the following BMC Space Banner macros.

If your space requires another kind of announcement, you can use this page in coordination with your team lead and editors.

When should I use a space announcement banner?

Use the space organization announcement after you change the content from a book-like organization (such as User Manual, Configuration Manual, and Administration Guide) to the product model.

Use the latest version announcement to push traffic to later versions. You do not need to add this to every previous version, but if you have a specific reason that you want users to be aware—for example, Google searches show content for an obsolete version—use the banner to help users find a relevant version.

When an announcement is no longer needed, remove the BMC Space Banner macro.

Space announcement This documentation space provides the same content as before, but the organization of the content has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

File-AID/RDX Extract/Load/Delete request file


The Extract/Load/Delete Request file contains records that reflect the values you specified in the during the interactive phase of the extract, load, or delete process. The Extract/Load/Delete Request file evolved from the Extract Criteria file from earlier versions of File-AID/RDX.

The following figure shows a sample request file. Note that in the figure the reserved spaces for Db2 creator ID and table names (up to 128 spaces for each) have been reduced to fit into this figure. When viewing the request file online, use the RIGHT and LEFT scroll commands to view the Db2 object names at the end of the records.

The request file has the following characteristics: 

File organization

Either partitioned or sequential (DSORG=PO or DSORG=PS)

Record format

Variable-blocked (RECFM=VB)

Logical record length

Maximum LRECL determined by File-AID/RDX (default is 1004)

Important

Pre-Release 4.3 extract/load request files have fixed or fixed-blocked (RECFM=F or RECFM=FB) record format (see also Save Extract Request).

The first two bytes of each record contains either blanks or “--.” Records with blanks in positions 1 and 2 are processed by SPUFI. Records that start with the characters “--” are considered comments by SPUFI and are, therefore, ignored.

The third and fourth bytes of each record contain the record’s type.

Sample Extract/Load Request File

-00FILE-AID/RDXVERSION 17 RELEASE 02 MOD 00 SUB 26                        EP
--401  NN00037Y
--281        TSOID01.FRSAMP.EXTRACT                               OLD          -
--291SYSDA         TRK0010005000VB 027994027998
--282        TSOID01.FRSAMP.EXTCRIT2                    PCUST    NOLD          -
--27DESCRIPTION: DB2-FRSAMP.ORDER_TABLE
--292SYSDA         TRK0004004010FB 000080000000
--286        TSOID01.FRSAMP.RELATION                              OLD          -
--296              CYL
--287        TSOID01.RDX.PROFILE                                  OLD          -
--297              CYL
--28B        TSOID01.FRSAMP.DISGUISE                              OLD          -
--29B              CYL
--56DRIVING:                                                        LOCK =N D701DD701CW01    FRSAMP          ORDER_TABLE
--14          C=*     M=*        N=*   X=N  P=NONE         I=Y           001/001
--57MODEL:   D801DD801CW01        FRSAMP                                                              ORDER_TABLE
--70 DISG=3 RETAIN=Y AUDIT=N PREFIX=KFL                                        8
--56RELATED:                                                        LOCK =N D701DD701CW01    FRSAMP          CUSTOMER_TABLE
--15          C=*     M=*        N=*   X=N  P=NONE     U=N I=Y           001/001
--56RELATED:                                                        LOCK =N D701DD701CW01    FRSAMP          CONTACT_TABLE
--15          C=*     M=*        N=*   X=Y4 P=NONE     U=N I=Y           001/001
--56RELATED:                                                        LOCK =N D701DD701CW01    FRSAMP          ORDER_LINE_TABLE
--15          C=*     M=*        N=*   X=N  P=NONE     U=N I=Y           001/001
--56RELATED:                                                        LOCK =N D701DD701CW01    FRSAMP          PART_TABLE
--15          C=*     M=*        N=*   X=N  P=NONE     U=N I=Y           001/001
--56RELATED:                                                        LOCK =N D701DD701CW01    FRSAMP          SUPPLIER_TABLE
--15          C=*     M=*        N=*   X=Y4 P=NONE     U=N I=Y           001/001
--06CHASE ALL RELS:  Y
--07DPSI=YYNN C=*     M=*        MAX=Q UR=Y IMAGE=N F2    V=N A=N S=N COMPRESS=N KT_EMEM=E CK_EMEM=E KT_DEGR=9 GH=Y
--52P D                                                               0         D701CW01    FRSAMP           CUSTOMER_TABLE        FRSAMP
--53D7017100
--52D D                                                               0         D701CW01    FRSAMP           ORDER_TABLE
--53D7017100
--13DPSI=-YN- C=*     M=*        D=*   X=N  E=NN A
--16MISCDB2:2005-07-14 10.11.36       TSOID01
--50SOURCE COLUMN=CUSTOMER_NUMBER                 TYPE=CHARACTER LENGTH= 00006
--51OFFSET= 00000SUB1=00000SUB2=00000SUB3=00000NOSUB=00000PREC=00000SCALE=00000
--50TARGET COLUMN=CUST_NUM                        TYPE=CHARACTER LENGTH= 00006
--51OFFSET= 00000SUB1=00000SUB2=00000SUB3=00000NOSUB=00000PREC=00000SCALE=00000
--52P D                                                               1         D701CW01    FRSAMP           CUSTOMER_TABLE        FRSAMP
--53D7017100
--52D D                                                               1         D701CW01    FRSAMP           CONTACT_TABLE
--53D7017100
--13DPSI=---N C=*     M=*        D=*   X=N  E=   RCONTCUST
--16MISCDB2:2005-07-08-09.39.50.880402        2005-07-08-09.39.50.880402
--50SOURCE COLUMN=CUSTOMER_NUMBER                 TYPE=CHARACTER LENGTH= 00006
--51OFFSET= 00000SUB1=00000SUB2=00000SUB3=00000NOSUB=00000PREC=00000SCALE=00000
--50TARGET COLUMN=CUSTOMER_NUMBER                 TYPE=CHARACTER LENGTH= 00006
--51OFFSET= 00000SUB1=00000SUB2=00000SUB3=00000NOSUB=00000PREC=00000SCALE=00000
--52P D                                                               2         D701CW01    FRSAMP           CUSTOMER_TABLE    
    FRSAMP
--
53D7017100
--52D I                                                               2         IX.FISAMP.DBDLIB             PCUST                 
--13DPSI=YYNN C=*     M=*        D=*   X=N  E=   A
--59C TSOID01.FRSAMP.CONDAR                        P0000001
--16MISCDB2:2005-07-14 10.13.52       TSOID01

A request file could contain the record types as listed in the following table.

File-AID/RDX Request File Record Types

Record Type

Description

00

This record type indicates the version, release, modification level, subrelease of File-AID/RDX that created the file. It also indicates the request type: E=extract, L=load, B=both extract and load, or D=delete, whether it is a P=permanent (saved) or T=temporary request, and Y flags the request as Nonexecutable.

blank

This record type contains the Db2 SELECT statement(s) generated by the Db2 Object Selection Criteria screen. This record type has no record-type number associated with it.

40n

This record type provides information whether the request includes an Input (external) Key file and/or summary file, creates a record layout and/or XREF file, which layout language is to be used. It also includes the CCSID of the terminal saving request, whether to use Db2 parallelism, whether to create a Topaz Extract Visualizer file, and whether Checkpoint/Resumption is enabled. The third digit n specifies the file type. See type 28 for a list of the file types.

28n

This record type specifies file name and disposition information for the different files in the current request. The third digit n specifies the file type:

n
1 = Extract file
2 = Request file
3 = Extract summary file
4 = Record layout file
5 = XREF file
6 = Relationship file
7 = Profile file
8 = Input (External) Key file
B = Disguise Control file (DCF)
D = Topaz Extract Visualizer file
E = Checkpoint Control file
F = Checkpoint Data file
Y = GDG file

27

This record type contains the request description (50 bytes).

29n

This record type specifies file allocation information for the corresponding type 28 files in the current request. The third digit n specifies the file type. See type 28 for a list of the file types.

56

56 DRIVING: This record type identifies the driving object type (D=Db2, M=MVS), and object name of the driving object at the end of the record to accommodate long object names. For Db2 objects it also includes the location and creator ID, each providing space for the maximum length. In addition, the type 56 record contains the value specified in the Lock Table field on the Extract Scope - Object View screen, with FUNCTION LOCK enabled (see also L (Lock Table) and FUNCTION LOCK) and the Db2 subsystem ID.

54

This record type is only included if record type 56, 52P or 52D is an MVS object. It follows each MVS 56, 52P or 52D record to identify the object’s layout type (S=Single, X=XREF), layout file name, member name, and IO exit name.

54A

This record type is a continuation record for record type 54. It identifies the 01 level record name.

55

This record type is only included if the preceding record type 54 is an XREF type (54X). It follows each 54X or 54A record to identify the object’s XREF file name, and member name.

44

This record type identifies the location, subsystem, creator, and table name of the base table associated with the view you specified as the driving table. This record type occurs only when you specify a view as the driving table. When the 44 record type occurs, it follows the 56 Driving: record type and precedes the 56 Related: record type.

18

This record type identifies the type and name of the Input (external) Key file specified as selection input to the driving object. Valid types are Standard and Delimited. For delimited key files type 18 record includes the delimiter options as specified during the selection criteria specification: 1 or 2 for single (1) or double (2) quotation marks, the column delimiter (, is default), Y or N for quotes on character data, and Y or N for quotes on numeric data. See also Input Key File Specification.

14

Db2 Driving object only. This record type contains

  • C= cycle limit for the object;
  • M= maximum number of records to extract from this object;
  • N= select every nth record from this object;
  • X= object excluded status:
    • object not excluded;
    • Y1 object excluded by user;
    • Y2 object excluded by line command "A" (All);
    • Y3 object excluded by object not found;
    • Y4 object excluded by scope;
  • P= Passthru status:
    • ALL extract all records (line command "A");

      PASSTHRU don’t extract records (line command "P");

    • NONE extract related records as applicable;
  • I= satisfy AR/RI indicator Y or N
  • nnn/nnn Set number of Total Set number;

57

57 MODEL: This record type identifies the Db2 object that the driving object used for its relationships even though no relationships were defined for the Db2 driving object.

70

Identifies the data disguise information for this extract request.

  • DISG=disguise extract option 1 (DCF), 2 (DPR) or 3 (no)
  • RETAIN= retain pre-disguise extract file Yes or No
  • AUDIT= create data disguise audit trail files Yes or No
  • PREFIX= identifies the prefix for the data disguise audit trail files

45

Identifies the BMC Compuware File-AID Data Privacy Dynamic Privacy Rules Project name and ID as well as the Privacy Rules Repository name for this extract request.

17

This record type contains the part of the SELECT statement generated by the key file selection input to the driving object. It contains the Db2 column or MVS field name and the location and type of the selection value in the key file. For delimited files, the INDSN parameter specifies the field number, for standard files, it specifies the starting position, length, and type.

56

56RELATED: This record type identifies the object type (D=Db2, M=MVS), and object name of a related object at the end of the record to accommodate long object names. For Db2 objects it also includes the location and creator ID, each providing space for the maximum length. In addition, the type 56 record contains the value specified in the Lock Table field on the Extract-Scope-Object-View-panel screen, with FUNCTION LOCK enabled (see also L (Lock Table) and FUNCTION LOCK) and the Db2 subsystem ID. A type 56 Related: record exists for every related object included in the extract.

58

58Clone: This record type identifies the cloned objects. There can be many 58 record types listed per request. They list the original and new names. The type of clone change is identified with a five digit code XYnnnwhere:

X is the major type:
G = global parameter
U = object identification
S = SSID
L = location

is the minor type:
D = DSN change
N = object name
L = layout
X = XREF
I = IMS and Output key file
nnn only applies to major/minor type GD
000 = Extract file
001 = Extract request file
002 = Extract summary file
003 = Extract Record layout file
004 = Extract XREF file
005 = Relationship file
006 = Profile file
007 = Input (External) Key file
008 = Disguised Extract file
009 = Disguise Criteria file
010 = Disguise Control file (DCF)
011 = Business Rules file

15

Db2 Non-Driving objects. This record type contains

  • C= cycle limit for the object;
  • M= maximum number of records to extract from this object;
  • N= select every nth record from this object;
  • X= object excluded status:
    • N object not excluded;
    • Y1 object excluded by user;
    • Y2 object excluded by line command "A" (All);
    • Y3 object excluded by object not found;
    • Y4 object excluded by scope;
  • P= Passthru status:
    • ALL extract all records (line command "A");

      PASSTHRU don’t extract records (line command "P");

    • NONE extract related records as applicable;
  • U= unrelated object Y or N
  • I= satisfy AR/RI indicator Y or N
  • nnn/nnn Set number out of Total Sets

07

This record type contains global navigation and sampling controls as well as other extract options.

  • DPSI= The status YN, or - (not relevant) is given for the global Navigation controls DPSI (Direct Path, Parent Path, Sibling Path, and Indirect Path). Direct Path status can also be C for All Children only and P for Plus (see also Direct).
  • C= global cycle limit;
  • M= maximum number of records to extract for entire execution;
  • MAX= Q (Quiesce) or S (Stop);
  • UR= uncommitted read (Y or N)
  • IMAGE= image copy (Y or N)
  • V= capture View DDL (Y or N)
  • F= Db2 Format (1=Unicode, 2=Conversion to EBCDIC, default)
  • A= capture Alias DDL (Y or N)
  • S= capture Synonym DDL (Y or N)
  • COMPRESS= compress extract file (C, V or N)
  • KT_EMEM= key tree in 64 bit memory (E or blank)
  • CK_EMEM= chase keys in 64 bit memory (E or blank)
  • KT_DEGR= key tree usage degree n (1-9)
  • GH= extract IMPLICITLY HIDDEN columns (Y or N)

09

This record type contains Temporal Table Business or System Time information.

  • B or Business Time or System Time
  • Dual (Bi-temporal)
  • 1, 2, or Time period: AS OF (1), FROM (2), or BETWEEN (3)
  • Y active or N inactive
  • Date/Timestamp 1
  • Date/Timestamp 2

23

Description of extract selective column and delimited file options. Db2 single table extract only. This record type contains

  • Data set format: 1=standard, 2=delimited;
  • Delimited quotation marks: 1=single, 2=double;
  • Delimited column delimiter: , (default);
  • Delimited quotes on character data: Y or N;
  • Delimited quotes on numeric data: Y or N;
  • Delimited extract column names: Y or N;
  • Delimited date format: as specified, for example, YYYMMDDYYYY
  • Delimited number of columns in table, for example, 0013

24

Description of extract selective column and delimited selection and sort order. Db2 single table extract only. This record type contains:

  • Column number from the catalog, for example, 00001
  • Selected column: S or numerical order number;
  • Column sort order: 1 indicates the primary sort column;
  • Sort direction: A=ascending (default), D=descending

The following table lists the group of record types 52P or 11, 10, 52D or 12, 13, 16, 50S or 21, 50T or 22, 51, 53, 54, 30, 31, and 32 will be present for each relationship being processed, dependent also on the respective object type.

File-AID/RDX Request File Relationship Record Types

Record Type

Description

52P

This record type contains information about the source object that is related to the object described by the type 52D record immediately following this type 52P record. The type 52P record identifies the source object’s object type (D=Db2, M=MVS), File-AID/RDX generated unique object sequence number, and fully qualified name at the end of the record to accommodate long object names. If the driving object is a Db2 object, the creator ID of the relationship definition used (model creator ID) is also included.

53

This record type exists only if record type 52P or 52D is a Db2 object. It follows each Db2 52P or 52D record to identify the Db2 object’s subsystem, DBMS version, release, modification level, and delimiter identifier.

52D

This record type contains information about the target object that is related to the object described by the type 52P record immediately preceding this type 52D record. The type 52D record identifies the target object’s object type (D=Db2, I=KEY, M=MVS), File-AID/RDX generated unique object sequence number, and fully qualified name at the end of the record to accommodate long object names.

13

This record type contains the individual navigation and sampling controls for each relationship as well as other extract options.

  • DPSI= The status YN, or - (not relevant) is given for the Navigation controls DPSI (Direct Path, Parent Path, Sibling Path, and Indirect Path) for each relationship.
  • C= cycle limit for the relationship;
  • M= maximum number of records to extract for this relationship;
  • D= select n dependents from this parent;
  • X= relationship excluded status:
    • N relationship not excluded;
    • Y1 relationship excluded by user;
    • Y2 relationship excluded by line command "A" (All);
    • Y3 relationship excluded by object not found;
    • Y4 relationship excluded by scope;
  • E=YY check extract validation status:
    • Y_ (first Y) possible RI violation;
    • _Y (second Y) ignore parent missing;
  • A or R identifies relationship type:
    • A application relationship (AR);
    • R Db2 RI;
  • The remaining characters identify either the RELNAME (8 bytes) if the relationship is Db2 RI, or the relationship description for AR.

59C

This record type identifies a conditional application relationship (AR-C) and includes the name of the conditional AR Criteria data set and parent criteria member name (Pnnnnnnn).

16

This record type contains the relationship’s creation and last modified time, date, and user ID.

A group of record types 50Source and 50Target (old 21 and 22, or 30 to 32) will be present for each pair of source and target columns in the relationship as listed in the following table.

File-AID/RDX Request File Source and Target Record Types

Record Type

Description

50

Source column. This record type contains information about the source object column or field that participates in a column/field relationship with the target object column/field described by the type 50Target column immediately following the type 51 record for the source column/field. The type 50Source column record identifies the source object’s column/field name, data type, and length.

51

This record type is a continuation record for all type 50 records. The type 51 record identifies the column/field offset, values for subscripts 1, 2, and 3, the total number of subscripts (0, 1, 2, or 3), precision, and scale defined for the relationship.

50

Target column. This record type contains information about the target object column or field that participates in a column/field relationship with the source object column/field described by the type 50Source column immediately preceding the type 51 record for the source column/field. The type 50Target column record identifies the target object’s column/field name, data type, and length. It is always followed by a 51 record type to specify the column/field values for offset and subscripts.

31

This record type contains the relationship description for this KEY relationship.

32

This record type contains the name of the extract Output Key File for this KEY relationship. It also includes the data set name containing the JCL for the BMC Compuware File-AID for IMS extract if it is to be executed as a step following the File-AID/RDX extract.

33

This record type contains the Output Key File data set details.

Load/Delete Request Record Types.

A request file could also contain these different load or delete request record types listed in the following table.

File-AID/RDX Load/Delete Request File Record Types

Record Type

Description

60n

This record type specifies the extract file type for the load in the current request. The third digit n specifies the file type:
n
1 = Extract file
2 = Extract summary file (tape control file)
3 = Request file
4 = Discard file

61

This record type contains the following global load parameters:
Db2 load option S=SQL Insert, D=Db2 load utility;
Automatic Space Calculation (MVS only);
Commit interval:
Discard options;
Db2 Lock and Log options;
Image copy;
Repair
Auto create only

62

This record type contains the Target Object Names.

63

This record type contains the source to target Column Mapping information.

64

This record type contains the index auto create information.

65

This record type contains the index detail information.

66

This record type contains the discard file information.

67

This record type contains the partitioned index limitkey value information.

68

This record type contains the Db2 Alias, Synonyms, and View information.

69

This record type contains the Db2 Target Database information.

70

This record type contains the Db2 Target Tablespace information (obsolete, replaced with record type 73).

71

This record type contains the DSATT information for MVS objects.

72

This record type contains the Index detail specifications information for MVS objects.

73

This record type contains the Db2 Target Tablespace information.

Obsolete Record Types

An extract criteria file saved with an earlier File-AID/RDX Release than 4.0 could contain the following record types. When processed with File-AID/RDX Release 21.01 or later, these record types will be replaced by their corresponding Release 21.01 record types.

Obsolete Record Types

Record Type

Description

01

This record type contains the value specified in the Maximum rows to select from Driving object field on the Selection Criteria Specification screen. For multiple selection criteria sets, the set number is located on the right, for example 001/003 (set# out of total sets).

02

This record type contains the request description.

03

This record type contains the value specified in the Maximum rows from all tables field on the Extract Scope Screen screen.

08

The Max Cycles record type corresponds to the values specified in the Cycle Control window. It lists the number of allowed extract cycles and whether orphan records are acceptable (Get Parents of Orphans:N) or (Get Parents of Orphans:Y).

02

This record type contains the value specified in the Select every nth row from driving table field on the Selection Criteria screen. This record type exists only in extract criteria files created using File-AID/RDX version 1.1 and earlier and will be replaced by record type 14 when saving the extract criteria with a current release of File-AID/RDX.

04

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the selection criteria with File-AID/RDX version 2.0 and later it will be replaced with type 56 record.

This record type identifies the location, subsystem, creator, and table name associated with the driving table. In addition, the type 04 record contains the value specified in the Lock Table field on the Selection Criteria Specification screen.

If you specified a view as the driving table, this record type identifies the location, subsystem, creator, and view name associated with the view. Record type 44 identifies the location, subsystem, creator, and the view’s base table name.

05

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the selection criteria with File-AID/RDX version 2.0 and later it will be replaced with type 56 record.

This record type identifies the location, subsystem, creator, and table name associated with a related table. In addition, the type 05 record contains the value specified in the Lock Table field on the Selection Criteria Specification screen. A type 05 record exists for every related table included in the extract.

06

This record type corresponds to the value specified in the Display all relationships field on the Extract Specification screen in File-AID/RDX versions prior to 3.0.

11

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with File-AID/RDX version 2.0 and later it will be replaced with type 52P and 53 records.

This record type contains information about the source table that is related to the table described by the type 10 or 12 record immediately following this type 11 record. The type 11 record identifies the source table’s location; subsystem; creator; table name; and DBMS version, release, and modification level.

10

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with the File-AID/RDX version 2.0 and later it will be replaced with type 52D records.

This record type identifies the target IMS database (DBDLIB) and the target member that is related to the table described by the type 11 record immediately preceding this type 10 record.

12

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with File-AID/RDX version 2.0 and later it will be replaced with type 52D and 53 records.

21

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with File-AID/RDX version 2.0 and later it will be replaced with type 50Source Column records.

This record type contains information about the source table column that participates in a column relationship with the target table column described by the type 22 record immediately following this type 21 record. The type 21 record identifies the source table column’s name, data type, length, and offset, if any.

22

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with File-AID/RDX version 2.0 and later it will be replaced with type 50Target Column records.

This record type contains information about the target table column that participates in a column relationship with the source table column described by the type 21 record immediately preceding this type 22 record. The type 22 record identifies the target table column’s name, data type, length, and offset, if any.

30

This record type exists only in extract criteria files created using File-AID/RDX version 1.6 and earlier. When saving the extract criteria with File-AID/RDX version 2.0 and later it will be replaced with type 50Target Column records.

This record type contains information about the IMS target root segment that participates in a column relationship with the source table column described by the type 21 record immediately preceding this type 30 record. The type 30 record identifies the IMS target root segment’s name, data type, length, and offset, if any.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*