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.

Package Selection

The Package Selection screen (Package Selection Screen) displays when Package is selected on the SQL Plan Analysis Specification screen, or when a Collection ID is selected on the Collection ID Selection screen (Collection ID Selection Screen). This screen lists detailed package information, including collection ID, package name, bind timestamps, and version.

CMD

Specify the line command to be performed on the selected package.

S

Displays specific package information. The SQL Statement Selection screen (SQL Statement Selection Screen) displays. If no detailed information is available for the package, the error message NONE EXPLAINABLE displays.

X

Performs an Explain of the entire package.

If you entered 1 for online processing on the SQL Plan Analysis Specification screen (SQL Plan Analysis Specification Screen), the SQL Analysis Summary screen (SQL Analysis Summary) displays.

If you entered 2 for batch processing on the SQL Plan Analysis Specification screen (SQL Plan Analysis Specification Screen), the Batch Plan Analysis Reports window (Batch Plan Analysis Reports Window) displays. See Explaining-Objects-in-Batch for more information.

Note: To explain the package, it must contain one of the following SQL statements: DECLARE CURSOR, DELETE, INSERT, SELECT, or UPDATE. If it cannot be explained, the error message NONE EXPLAINABLE displays.

Package Selection Screen

image2021-3-11_19-20-41.png

Sorting Package Entries

The SORT primary command can be used to change the order in which package entries are displayed. Multiple column names are not accepted. The selected columns are sorted in ascending sequence. The valid column names that can be used with the SORT command are listed below. Abbreviations are noted within parentheses.

  • Name (NA)
  • Time (TI)
  • Collid (CI)
  • Version (VER)

For example, to sort the display by the bind timestamp, enter the command SORT TI.

Related topics

SORT

SQL-Plan-Analysis-Specification


 

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