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.

Relationship file


The relationship file contains information about relationship definitions that File-AID/RDX uses in the extract process.

Relationship File Compatibility Notes

  1. Relationship files can be shared between BMC Compuware File-AID for Db2 and File-AID/RDX.
  2. Db2 long name support requires File-AID/RDX Release 4.3, or higher, or BMC Compuware File-AID for Db2 Release 4.8.1, or higher. Once a Db2 long name has been added to a Version 2 relationship file, File-AID/RDX updates it to a Version 3 relationship file. Version 3 relationship files are not downward compatible with earlier product releases.

Relationship File characteristics

The relationship file has the following characteristics:

File Organization

VSAM-KSDS

Record Format

Variable

Logical Record Length

Maximum record size is 4765

Maximum columns

38

Key Length

74

Use the File-AID/RDX Relational Facilitator Option A to allocate a new relationship file (see Allocate Relationship File).

The relationship file stores information about relationships including the following:

  • Db2 table names;
  • Db2 column names and attributes; and
  • Db2 subsystem ID.
  • MVS file names;
  • MVS record layout and XREF information;
  • MVS field names and attributes;

The relationship file stores information about two types of relationships:

Referential Integrity (RI)

Db2 defined referential integrity information taken from the Db2 catalog. Referential integrity information is initially loaded using a batch job and can be updated with the File-AID/RDX Batch RI Load utility. See Batch RI Load for a description. You also can load individual RI relationships using the online Load RI option or line command in Option 1, Relationships.

Application Relationship (AR)

User-defined relationship information for relationships between Db2 and/or MVS objects, as well as relationship information for Db2 or MVS parent objects to IMS dependent object relationships. You can create and modify AR relationship information from within File-AID/RDX.

Relationship File Layout

The File-AID/RDX Release 2.0 Relationship File contains information about RI and AR relationships. File-AID/RDX takes information about RI relationships from the Db2 catalog. You provide information about AR relationships when you create them in Option 1 with the Add AR option or line command.

The relationship file is a fixed format file. There is one record in the file for each parent and child object. Each record contains the following groupings depending on whether the object is a parent or child and whether it is a DB2, MVS, or IMS or Output Key object type.

Key (all objects)

Identifies the object, the object type and whether it is the parent or child in the relationship.

Related Object Information (all objects)

Identifies the related object, the product and release that created the relationship as well as the relationship type, RI or AR.

Relationship Details (parent objects only)

Includes the relationship description and creation and last modification timestamps, database version, and parent and child column/field information.

MVS Record Layout Information

Identifies the record layout and cross-reference data used when defining the relationship.

Key

Identifies the object, the object type and whether it is the parent or child in the relationship.

Key Fields

Field Name

Type

Length

Description

RDX-key Sync

GRP

74

RDX key group.

Obj-group

CHAR

16

Object group. Reserved for future use.

Obj-type

CHAR

1

Object type. D = DB2, I = IMS and KEY, M = MVS.

Obj-name

CHAR

52

Object name. Fully qualified name of the object; for Db2 objects, for example, it consists of location.creator.object.

Obj-nm-DB2 Sync

GRP

52

Redefines the object name to fit Db2 naming convention.

Location

CHAR

16

Location name

Creator

CHAR

8

Creator ID

Table

CHAR

18

Table or view name

Filler

CHAR

10

Filler

Obj-nm-MVS Sync

GRP

52

Redefines the object name to fit MVS naming convention.

MVS-DSN

CHAR

44

Fully qualified MVS file name

Filler

CHAR

8

Filler

Obj-nm-IMS Sync

GRP

52

Redefines the object name to fit IMS naming convention.

DBD-LIB

CHAR

44

Fully qualified IMS DBD-Library name

DBD-Member

CHAR

8

Member name

SEQ-NO

Binary

4

Unique number to identify specific relationship

Par-child-ind

CHAR

1

Parent child indicator: P = Parent, = Child (dependent)

Related Object Information

Identifies the object that is related to the object specified in the above Key.

Related Object Information

Field Name

Type

Length

Description

Rel-Object Sync

GRP

73

Related object information group

Rel-Obj-group

CHAR

16

Related object group. Reserved for future use.

Obj-type

CHAR

1

Related object type. D = DB2, I = IMS, M = MVS.

Rel-Obj-name

CHAR

52

Related Object name. Fully qualified name of the object; for Db2 objects, for example, it consists of location.creator.object.

Rel-Obj-SEQ-NO

Binary

4

Unique number to identify specific relationship for the related object

Version-stamp Sync

GRP

18

Information about the product that created this entry.

product_id

CHAR

2

ID of the product that created this entry.

product_rel

CHAR

8

Version, release, and modification level of the product that created this entry.

Func-release

CHAR

8

Relationship release used to update this entry.

Rel-type

CHAR

2

Relationship type:

RIReferential Integrity

ARApplication Relationship

Depend-full-name-offset

PIC

S9999

Offset for dependent full name (long object names only)

Parent-full-name-offset

PIC

S9999

Offset for parent full name (long object names only)

Long-name-text

PIC

X(550)

Full object name (long object names only) for parent and dependent Db2 long name objects. Includes: total length, object type, location name length, location name, creator name length, creator name, table name length, table name.

Relationship Details (parent objects only)

The following fields provide information about the Relationship Details and is only included for parent objects.

Relationship Details (parent objects only)

Field Name

Type

Length

Description

rel-description

CHAR

30

Description of the relationship. For RI relationships, this is the RELNAME from the Db2 catalog. For AR relationships, this is the description entered on the Column Relationships screen.

Parent-delim-ind

CHAR

1

Parent delimiter indicator.

No delimiter required

Delimiter required for Table

Delimiter required for Creator

Delimiter required for Table and Creator

Delimiter required for Location

Delimiter required for Table and Location

Delimiter required for Creator and Location

Delimiter required for Table, Creator and Location

Depend-delim-ind

CHAR

1

Dependent delimiter indicator. See Parent delimiter indicator for explanation of possible values.

Audit-info Sync

GRP

68

Timestamp and User ID for creation and modification of the relationship

Load-tmstmp

CHAR

26

Timestamp indicating when the relationship was created or loaded into the relationship file. The timestamp is written in the following format: YYYY-MM-DD-HH.MM.SS.NNNNNN

Load-userid

CHAR

8

Userid that created or loaded the relationship.

Mod_tmstmp

CHAR

26

Timestamp indicating when the relationship was last modified. The timestamp is written in the following format: YYYY-MM-DD-HH.MM.SS.NNNNNN

Mod_userid

CHAR

8

Userid that last modified the relationship.

Rel-data-DB2 Sync

GRP

14

Database information for the relationship

DBMS-info-parent Sync

GRP

7

Database information for the parent

DBMS-VRM

CHAR

3

DBMS version

DBMS-SubsysID

CHAR

4

DBMS subsystem ID

DBMS-info-child Sync

GRP

7

Database information for the dependent

DBMS-VRM

CHAR

3

DBMS version

DBMS-SubsysID

CHAR

4

DBMS subsystem ID

Filler

CHAR

4

Filler

Parent-full-name-offset

PIC

S9999

Offset for parent full name (long names only)

Depend-full-name-offset

PIC

S9999

Offset for dependent full name (long names only)

Column-source Sync

GRP

112

Parent and child column/field information

Number-cols

Binary

2

Number of related columns.

Column-detail (1) Sync

GRP

110

Parent and child column/field detail information; occurs 1 to 38 times depending on the number of related columns

Par-col-name

CHAR

31

Parent column/field name

Par-col-sub1

Binary

2

Parent column subscript 1

Par-col-sub2

Binary

2

Parent column subscript 2

Par-col-sub3

Binary

2

Parent column subscript 3

Par-col-type

Binary

2

Parent column type

Par-col-length

Binary

2

Parent column length

Par-col-offset

Binary

4

Parent column offset

Par-no-subscr

Binary

2

Number of Parent column subscripts

Par-precision

Binary

2

Precision of Parent column

Par-scale

Binary

2

Scale of Parent column

Filler

Binary

4

Filler

Dep-col-name

CHAR

31

Child column/field name

Dep-col-sub1

Binary

2

Child column subscript 1

Dep-col-sub2

Binary

2

Child column subscript 2

Dep-col-sub3

Binary

2

Child column subscript 3

Dep-col-type

Binary

2

Child column type

Dep-col-length

Binary

2

Child column length

Dep-col-offset

Binary

4

Child column offset

Dep-no-subscr

Binary

2

Number of Child column subscripts

Dep-precision

Binary

2

Precision of Child column

Dep-scale

Binary

2

Scale of Child column

Filler

Binary

4

Filler

Long-name-text

PIC

X(550)

Full object name (long object names only) for parent and dependent Db2 long name objects. Includes: total length, object type, location name length, location name, creator name length, creator name, table name length, table name.

MVS Record Layout Information

The following fields contain information about the MVS Record Layouts that are used to define the relationship.

MVS Record Layout Information

Field Name

Type

Length

Description

Rel-data-file Sync

GRP

294

MVS Record Layout Information; (only applicable if one or both objects of the relationship are MVS object types)

Num-layouts

Binary

2

Number of MVS layouts defined in the relationship

Layout-info (1) Sync

GRP

146

Layout information for MVS object in the relationship; occurs 0 to 2 times depending on the number of MVS objects defined in the relationship.

Layout-type

CHAR

1

Layout type

Single

XREF

Layout-DSN

CHAR

44

Layout file name

Layout-Member

CHAR

10

Layout file member name

XREF-DSN

CHAR

44

XREF file name

XREF-Member

CHAR

8

XREF file member name

IO-exit-name

CHAR

8

IO exit name

Rec-01-name

CHAR

31

Rec-01 level name

 

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