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.

Impact Analysis Utility function

This section describes the Column Impact Analysis utility, which greatly reduces the time required to analyze object structures.

The Column Impact Analysis utility details an object’s dependencies and helps you visualize relationships. A batch report is produced that helps you determine the impact of dropping or modifying a column by identifying:

  • Views
  • Aliases
  • Synonyms
  • Indexes
  • DBRMs/Packages
  • Plans
  • Referentially related columns
  • Triggers

The report indicates if the column is used in any of the following clauses:

  • GROUP BY
  • HAVING
  • ORDER BY

Column Data Table

To create an accurate column impact report, you must have an up-to-date Column Data Table:

  • Use the sample JCL provided in member XFDCNLLI of the File-AID sample library (SXVJSAMP) to create and load the Column Data Table with column information for a Db2 subsystem. This job creates a Column Impact Analysis Profile library and a member in it for the target Db2 subsystem. The library and member will be used by the Column Data Table update job below.
  • Use member XFDCNLLM from SXVJSAMP to update the Column Data Table with any changed column information that has occurred since the initial table load above.

The File-AID for Db2 utility generates JCL to produce the Column Impact Analysis report. You can print the report to a printer or to a dataset. A sample report appears in Column Impact Analysis Report.

Column Impact Analysis

When you select option 8 from the Utility Selection Menu, the DBA-XPERT - Batch Column Impact Analysis screen appears.

Column Impact Analysis Screen

image2021-3-11_8-18-3.png

From the Column Impact Analysis screen, you must specify whether you want to create a new report or print a previously generated report. Each report has a unique report identification. You must also identify which related objects you want included in the report.

Specify Option

Enter the desired option.

1

Creates and prints a new impact analysis report.

2

Prints a previously created report.

Specify Report ID

Enter a name to identify the report. The identification name can contain up to eight characters. If you entered 1 in the option field, you must enter a new name.

If you entered 2, you must enter a previously entered report identification. If you do not know the ID, browse the control table using File-AID for Db2. Review columns IMPID and DESCRIPTION to help determine the desired report ID. See Impact Analysis Tablesfor information on the control table.

Specify DB2 Table, View, Alias or Synonym Area

Creator

Creator of the table, view, alias, or synonym against which you are running the report.

Name

Name of the table, view, alias, or synonym against which you are running the report.

Specify Report Options Area

Specify which objects you want included in the report.

Views

Specify Y to include views in the report. Specify N to not include them.

Aliases

Specify Y to include aliases in the report. Specify N to not include them.

Synonyms

Specify Y to include synonyms in the report. Specify N to not include them.

Indexes

Specify Y to include indexes in the report. Specify N to not include them.

Description

Enter a description of the report. The description is saved in the control table.

DBRMs/Packages

Specify Y to include DBRMs and packages in the report. Specify N to not include them.

Plans

Specify Y to include plans in the report. Specify N to not include them.

RI Columns (referentially related columns)

Specify Y to include referentially related columns in the report. Specify N to not include them.

Triggers

Specify Y to include triggers. Specify N to not include them.

Indent character

When formatting the report, indentation is used to display information. Enter the desired indent character. A vertical bar (|) is recommended.

Table prefix

Table prefix is used to create unique control and report tables for each report. Prefixes can contain up to four characters. See Impact Analysis Tablesfor further information on this field.

Specify Column Data Table

Specify the column data table for the current Db2 subsystem. For more information on how to create and update a column data table, see Column Data Table.

Creator

Creator of the column data table.

Name

Name of the column data table.

IMPACT Tables AUTHID

Specify the authorization ID (creator) for the Impact Analysis tables.

Impact Analysis Tables

When you create an impact report, File-AID for Db2 creates two tables:

Table Name

Explanation

Creator.table_prefixIMPACT

Report Table. Contains the information printed in the report.

Creator.table_prefixIMPACTID

Control table. Contains the input to the report generation program.

You have the option of entering a prefix for the impact tables. Enter a unique value each time you run the report to have new tables created for each report. The Create Impact Analysis Tables screen (Create Impact Analysis Table Screen) appears when new tables need to be created. If you always leave this field blank or enter the same prefix value, File-AID for Db2 displays the Create Impact Analysis Tables screen only the first time the tables are created. Then, each successive time you run a report, File-AID for Db2 appends the report information to the existing tables.

Create Impact Analysis Tables

The Create Impact Analysis Tables screen appears when File-AID for Db2 needs to create new control and report tables.

Create Impact Analysis Table Screen

image2021-3-11_8-20-30.png

Database

Enter the database name in which you want the tables created.

Tablespace

Enter the tablespace name in which you want the tables created. If you leave this field blank, File-AID for Db2 creates an implicit tablespace.

Impact Selection Template

The Impact Selection Template screen enables you to select the columns you want included in the report. For each column you select, the report displays the related objects you selected on the Column Impact Analysis screen (Column Impact Analysis Screen).

Enter an S in the SEL field next to the desired column name. When you have selected all the columns, type EXECUTE on the command line and press Enter, or press the associated PF key.

Impact Analysis Selection Template

image2021-3-11_8-21-17.png

SEL

Enter an S to select a column.

Column Name

List the columns in the table.

Batch Output Specification

The Batch Output Specification screen (Impact Analysis Output Specification Screen) appears when you use the EXECUTE command on the Impact Selection Template screen. It enables you to select whether you want the report to be written to a printer or to your output dataset. (See Print-Options for information on setting the default values for this screen.)

Press Enter on this screen to view the generated JCL in ISPF/PDF Edit. The JCL is only temporary. You must use the CREATE or COPY primary command to save it. Execute the SUB command to submit the JCL and run the report. (See Batch-Options for information on setting your default jobcard.)

Impact Analysis Output Specification Screen

image2021-3-11_8-22-1.png

Column Impact Analysis Report Example

The following is a sample report. In the report, objects that are indented are dependent on the object in the preceding row. See Impact Analysis Report Explanation for a line by line explanation of the report. Impact Analysis Codes Explanation provides an explanation of the codes used in the report.

Column Impact Analysis Report

image2021-3-11_8-22-45.png

Impact Analysis Report Explanation

Name and Explanation

Additional Information

CL: DB2DFLT.EMP.WORKDEPT

Starting column

Type: CHAR
Length: 3
Scale: 0

| Parent TB: DB2DFLT.DEPT

Parent table to column DB2DFLT.EMP.WORKDEPT


| | Parent CL: DB2DFLT.DEPT.DEPTNO

This primary key column references the foreign key column DB2DFLT.EMP.WORKDEPT

Relname: RED
Col seq: 1

| | | Dep TB: DB2DFLT.DEPT

Dependent table


| | | | Dep CL: DB2DFLT.DEPT.ADMRDEPT

This foreign key column references the primary key column DB2DFLT.DEPT.DEPTNO

Relname: RDD
Col seq: 1

| | | | | IX: DB2DFLT.XDEPT3

Column DB2DFLT.DEPT.ADMRDEPT is in the first position of this index

Col Seq: 1

| | | Dep TB: DB2DFLT.PROJ

Dependent table


| | | | Dep CL: DB2DFLT.PROJ.DEPTNO

This foreign key column references the primary key column DB2DFLT.DEPT.DEPTNO

Relname: RPD
Col seq: 1

| | | IX: DB2DFLT.XDEPT1

Column DB2DFLT.DEPT.DEPTNO is in the first position of this index.

Col Seq: 1

| IX: DB2DFLT.XEMP2

Column DB2DFLT.EMP.WORKDEPT is in the first position of this index.

Col Seq: 1

Impact Analysis Codes Explanation

Code

Explanation

AL COL

Alias column

CL:

Starting column

Dep CL

Dependent column

Dep TB

Dependent table

DBRM

DBRM

IX

Index

Parent CL

Parent column

Parent TB

Parent table

PK

Package

PL

Plan

Relname

Relationship name

Ref VW

Referenced view

Ref VW Col

Referenced view column

ROOT

Beginning of the analysis for a selected column.

SY COL

Synonym column

TR

Trigger

Related topics

Object-Administration-and-Objects-Utilities

 

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