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.

Edit Options

This section discusses the edit options available in File-AID for Db2 including:

Edit Selection Template

The Edit Selection Template screen (Edit Selection Template) displays when you specified at the Edit Options screen to either create temporary selection criteria or modify selection criteria, and also that selection criteria is to be entered on the template.

The Edit Selection Template screen lets you specify the rows or columns of the object you want to edit. You can specify the order in which the columns are displayed. You can also specify the rows you want to use and the order in which they are displayed.

The message Trigger(s) exist informs you that one or more triggers are defined against the selected table. Trigger failures during the edit session will generate visible SQL codes.

The short message LOB(s) exist informs you that one or more LOB columns are part of the selected table.

If you are using an existing Edit Criteria Dataset, the SEL column is already prefilled with the selections from the Edit Criteria Dataset. You can then either accept or modify them as desired.

Important

You achieve Full Table Edit by NOT selecting any columns in the SEL column when entering the EXECUTE command.

A warning message displays on the Edit Selection Template if triggers exist and is activated by editing.

Edit Selection Template

image2021-3-10_11-36-19.png

Table Name

Creator ID and name of the object that you are editing.

Max Rows to Select

Maximum number of rows to be returned based on your selection criteria. See Maximum Rows to Select for details.

SEL

Type S (select) beside the column or columns you want to edit. If you want the columns displayed in a particular order, type the appropriate integer beside each column. Mixing integers and S selections displays the integer-selected columns first, with the S-selected columns following. You can also type X (exclude) beside one or more columns to specify that you want to exclude these column(s) from the edit. In this case all columns except the X columns will be displayed. X cannot be used in combination with S or integer selections. File-AID for Db2 displays the column(s) in edit or browse when you use the EXECUTE command. If you do not mark any columns for selection, all columns are selected and presented in the order listed.

Key/Index Indicator

(Untitled 1 byte field) Indicates P Primary key, F Foreign Key, or I High Order Index key (if not Primary or Foreign) for the column as an aid for users to create SQL that will perform well.

Column Name

Names of all columns within the table or view.

Type(Length)

Type and length of the data in the column.

Distinct types are identified by their names.

If it’s a Unicode column, File-AID for Db2 displays one of the Unicode format indicators:


    • UTF-8
    • UTF-16
    • UTF-8S(CCSID=367,ASCII)

Order

Specify an integer to define how the returned rows should be sorted on the screen, based on the data content of the columns. Entering 1 indicates the primary sort column.

A/D

Specify whether the rows on this column data are sorted in ascending (A) or descending (D) order. If neither is specified, the columns are sorted in ascending order.

Where

Specify values limiting the rows displayed. The WHERE delimiter is analogous to the SQL WHERE clause in a SELECT statement. The WHERE field can be scrolled left and right. To scroll the WHERE field to the right, place the cursor in the WHERE field and press PF11. To scroll to the left, place the cursor in the WHERE field and press PF10. Scrolling allows you to view up to 256 characters.

You may use the following delimiter in your WHERE clauses:

>

OR

< >

<

> =

BETWEEN

=

< =

IN

¬ =

¬ >

LIKE

AND

¬ <

NOT

Important

Special considerations for distinct (UDT) data type columns: File-AID for Db2 generates the appropriate CAST function for simple WHERE clauses that contain just one of the following operators:

>

> =

< >

<

< =

¬ <

=

¬ =

¬ >

For all other WHERE clauses, you must enter the CAST function manually.

Executing or Saving Template, or Viewing/Editing SQL

After the appropriate selection criteria has been provided, you can execute or save the Template Selection Criteria, or view/edit the SQL. You can also view an alternate display of the template.

Use EXEC to Continue

Type EXECUTE on the command line and press Enter, or press the associated PF key to process the request. The Edit Table screen displays.

SQL to View/Edit SQL Source

Type SQL on the command line, and press Enter. File-AID for Db2 generates all SQL for the current function and places the SQL statements into a dataset and initiates an ISPF edit session (Edit SQL Selection screen).

If you specify M-Modify or E-Existing Selection Criteria Usage, this data set must be an existing sequential or partitioned data set with RECFM=FB and LRECL=80. The data set name is specified on the options panel in the Selection Criteria Dataset Name field. View/edit the data set, and then press END (PF3) to save any changes and exit the window.

If you specify T-Temporary Selection Criteria usage, a temporary data set containing the SQL source is created. An ISPF edit session (Edit SQL Selection screen) is initiated, enabling you to view/edit the SQL. If you want to save the SQL source, you must use the ISPF CREATE or COPY command before exiting the edit session.

SAVE

Type SAVE at the command line, and press Enter. The Selection Criteria Dataset Specification window (see the following figure) displays. This allows you to save the current Template Selection Criteria to a data set. If you do not want to save the current criteria, press END to exit this window.

Selection Criteria Dataset Specification Window

image2021-3-10_11-38-44.png

Dataset

Specify the name of the data set you want the selection criteria to be saved to. File-AID for Db2 prefills this field with the name of the last specified selection criteria dataset name.

Member

Specify the member of the data set you want to save the selection criteria to.

Press END if you do not want to save the current selection criteria to a data set. You are returned to the EDIT Selection Template.

SIZE

The SIZE command provides an alternate display of the Edit Selection Template which allows 58 positions of the WHERE clause to be displayed, and does not include all of the lines on the original display. The alternate display is designed to maximize the amount of rows displayed on the panel, so that you have a larger area to build a WHERE clause.

Type SIZE at the command line and press Enter. A panel is displayed (see the following figure) with only the Column name and WHERE columns displayed. Enter SIZE again to return to the original display of the Edit Selection Template.

Alternate Display of Edit Selection Template

image2021-3-10_11-39-44.png

Selection Template Not Prefilled

The Selection Template screen cannot be prefilled when there is an error processing the selection criteria. These errors could include:

  • S mismatch between the table name in the SELECT statement of the Edit Criteria data set and the one specified in the Table field of the Edit Options screen
  • The specified criteria does not contain a valid SELECT statement
  • The data set is empty

Selection Template Not Prefilled

image2021-3-10_11-40-27.png

Now you have several choices:

  • Select option 1 to execute the SQL of the existing Selection Criteria Dataset. If it contains a valid SELECT statement you can then edit or browse the table specified in the selection criteria.
  • Select option 2 to view and edit the SQL of the existing Selection Criteria Dataset before executing it. If the data set or data set member is empty or non-existing you can insert a SELECT statement in the Edit SQL Selection screen. See also SQL Entry Panel and Edit SQL Selection. You then edit or browse the table specified in the SELECT statement.
  • Specify option 3 to cancel and return to the Edit Options screen where you can:
    • Select a different creator and table combination that match the table name of the Edit Criteria.
    • Specify NO in the Use Existing Criteria field.
    • Specify a different Edit Criteria data set member combination that matches the creator and table combination.

SQL Entry Panel

The SQL Entry Panel (see the following figure) displays after you have returned from being in SQL mode. The panel prompts you for the name of an input criteria data set and a member name. The data set can have a previously saved SELECT statement or it can be empty, allowing you to enter a new SELECT statement. If the data set contains more than one SELECT statement, only the first statement is executed.

SQL Entry Panel

image2021-3-10_11-42-45.png

Specify Input Dataset Name Area

Criteria Dataset Name

Name of the data set in which the SQL query resides or will reside. Prefilled with the Edit Criteria data set name.

Member

Specify the desired member.

Specify Processing Options Area

Maximum Rows to Select

Maximum number of rows to be returned for the SELECT. (An asterisk in this field indicates that all rows should be returned. See Maximum Rows to Select for more information.) Only the first SELECT command in a data set is executed.

Edit SQL

Specify whether you want to edit the SQL before it is executed.

If the value of the Edit SQL field is YES, pressing Enter displays the Edit SQL Selection screen. If the value of the Edit SQL field is NO, pressing Enter executes the SQL statement and displays the Edit mode screen.

Edit SQL Selection

You access the Edit SQL Selection screen from either of the following:

  • SQL Entry Panel when you enter YES in the Edit SQL field on the SQL Entry Panel.
  • Prefilled EDIT Selection Template screen when you enter the SQL command. In that case the SQL is saved in the default SQL data set.

On this screen, you can enter a new SELECT statement or alter the existing one. The statement should be in standard SPUFI format.

Edit SQL Selection screen

image2021-3-10_11-44-34.png

Text Entry Area

Change or add to the SELECT statement using ISPF/PDF Edit. For more information concerning SPUFI, see the IBM SQL Reference Guide.

If on the Edit (or Browse) Options screen you specify T-Temporary Selection Criteria usage and T-Criteria Display Format, and on the Edit Selection Template screen you entered the SQL command, the Edit SQL Selection screen also provides the TEMPLATE (TEMP) command as indicated with the additional note:

=NOTE= YOU ARE EDITING A TEMPORARY DATASET THAT FILE AID FOR DB2
=NOTE= HAS GENERATED. IF YOU WANT THIS DATA SAVED, YOU MUST USE
=NOTE= THE ISPF CREATE OR COPY PRIMARY COMMAND BEFORE YOU EXIT
=NOTE= THIS PANEL.
=NOTE= THE TEMPLATE COMMAND IS AVAILABLE TO TRY TO POPULATE
=NOTE= SELECTION TEMPLATE SCREEN WITH THE CURRENT SQL CONTENTS

Use the TEMPLATE command in place of the END command to display the Edit Selection Template screen populated with the current SQL SELECT statement as long as the SQL can be parsed for display on the Template.

When you are satisfied with your SQL, press END to end the edit session or, if available, enter the TEMPLATE command.

TEMPLATE Command:


    • File-AID for Db2 parses the SQL for display on the Template screen and displays the Edit Selection Template screen populated with the current SQL.
    • If the Selection Template could not be populated, File-AID for Db2 returns an error message. You can either use the END command and try to execute the SQL or modify the SQL so it can be parsed for display on the Template screen.

END Command:


    • If you entered from the SQL Entry panel you return to the SQL Entry panel and are advised to press Enter to execute the SQL statement (see the following figure).
    • If you entered from the EDIT Selection Template screen and modified the displayed SQL, you are asked Execute modified SQL?. YES executes the SQL statement and you enter Edit or Browse; NO returns to the Selection Template screen.

SQL Entry Panel

image2021-3-10_11-46-29.png

Related topics

Description-of-Primary-Commands

Description-of-Line-Commands


 

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