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 contents


The relationship file (relationship repository) is a VSAM-KSDS file in which File-AID/RDX stores the following types of information:

Db2 Referential Integrity (RI) relationships

This relationship is one in which the dependent table rows contain foreign keys, the values of which are the primary index of the parent table. The rules that define RI relationships are enforced by Db2.

Use Option 5, LOAD RI from the DB2 Relationship Facilitator menu (Option 1, RELATIONSHIPS) for an online load or update of the RI information in the Relationship File. For more information, see Db2 RI Update Online Options.

To load or refresh RI information from the Db2 catalog with a batch job, use Option L, Batch RI Load, from the DB2 Relationship Facilitator menu (Option 1, RELATIONSHIPS). For more information, see Batch RI Load.

Application Relationships (AR)

This relationship is one in which values from dependent MVS file fields, Output Key file layout fields, IMS database root segments, or Db2 table or view columns match the values in corresponding parent MVS file fields or Db2 table or view columns. The rules that define application relationships are enforced by user applications, not by Db2 or other databases.

To define an application relationship File-AID/RDX needs to know the parent and dependent object names along with the names of the related column(s) or field(s). File-AID/RDX can assist you with the application relationship definition through its SUGGEST feature: File-AID/RDX will suggest relationships when column or field name, type, and length in the parent and dependent objects are identical.

When defining an application relationship for an MVS object, you must always identify the specific record layout or XREF information that defines the related field within the file.

A relationship can also be established from a Db2 or MVS parent to an Output Key file which contains a record layout, an IMS segment or both. The layout file or IMS segment is considered the dependent object. You define relationships for each field that is to be included in the extract Output Key file. The layout will determine the location and format of each field within the Output Key file. When the extract request is executed the Output Key file will be populated based upon the key values for the KEY relationship in the related extract.

The Output Key File can then be used by File-AID/RDX as an input (external) keys file against a driving object in another extract (see also Input Key File Specification) or as input into another process of your choosing. When the relationship is to an IMS segment, use the Output Key File with BMC Compuware File-AID for IMS to extract IMS data.

In addition, you can define relationships in BMC Compuware File-AID for Db2 and store them in the same relationship file you use with File-AID/RDX. You can view and modify these relationships using File-AID/RDX Option 1. BMC Compuware File-AID for Db2, however, does not support application relationships involving KEY (IMS) or MVS objects in its Related Edit/Browse function.

Conditional (“Data Driven”) Application Relationships (AR-C)

File-AID/RDX also allows you to define one or more conditions on the parent object within an application relationship. Use the COND primary command (see COND) to specify the conditions to test for. At extract execution time, the condition on the conditional object will be evaluated and the defined relationship will be navigated only when the condition is true.

A very simple example of this concept is a parent column that contains a code that if it has a value of "S" then a column named ID_COL has a social security number which is related to a table keyed by SSN, but if the code is "D" then the ID_COL has a driver's license number which is related to a different table.

For the sample scenario in the following figure, you would create four conditional application relationships with the respective conditional criteria defined on the parent object ACCOUNT.

Sample Scenario of Conditional AR

image2021-10-11_14-3-59.png

Considerations for MVS objects

File-AID/RDX supports defining application relationships for MVS objects as either parent and/or dependent objects. Before defining a relationship keep in mind:

  • File type must be SEQ, including GDG and GDS, KSDS, ESDS, or IAM1

    Important

    For File-AID/RDX to continue support of IAM (Innovation Access Method) file types, apply the appropriate IAM version fix(es): IAM Version 9.1 fixes P910005 and P910167, IAM Version 9.2 fix P920095, and IAM Version 9.3 fix P930003.

  • MVS object must be defined with a COBOL or PL/I record layout; COBOL and unaligned PL/I record layouts are compiled as interpreted by File-AID/RDX.
  • only one record layout per object in a relationship file (layout usage S); if more than one is required, use XREF (layout usage X)
  • only one XREF file per object in a relationship file
  • the LRCL must be less than or equal to 32,756 in order for the data records to be extracted
  • File-AID/RDX does not support undefined record format (RECFM=U).

GDG Considerations

File-AID/RDX supports relative GDG numbers in addition to the G0000V00 (i.e. .G0001V00) hard coded number for physical sequential files. File-AID/RDX allows you to define application relationships (AR) to or from a GDG or a GDS. Relationships are allowed between generations of the same GDG. If, for example, your current quarterly report is to extract from the current and the two previous months, you define these relationships:

  1. GDG.PAYMENTS.QUARTER(0) to GDG.PAYMENTS.MONTH(0)
  2. GDG.PAYMENTS.QUARTER(0) to GDG.PAYMENTS.MONTH(-1)
  3. GDG.PAYMENTS.QUARTER(0) to GDG.PAYMENTS.MONTH(-2)

When specifying the GDG base in a relationship, for example GDG.PAYMENTS.MONTH, File-AID/RDX extracts from all existing generations.

Use of Db2 views

File-AID/RDX supports defining application relationships for views in the suboptions of the Relationships Option function (Primary Menu Option 1). Views are treated just like tables and can be entered in any Table field. For example, you can define an application relationship for a view to any other dependent object (MVS, DB2 or KEY).

When you specify a view in either Relationships suboption, File-AID/RDX will display all relationships defined for the view. If no relationships are defined for the view, File-AID/RDX will not display any relationships. To see the relationships for the view’s base table you must enter the base table name.


 

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