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.

Primary commands


Primary Command Availability by Function

Primary
Command

Browse

Edit

Table
Mode

Row
Mode

SQL Analysis1

Utilities

Relationships

ADD

x

x

x

x



x

BOTTOM

x

x

x

x

x

x

x

BROWSE

x

x

x

x

x

x


CANCEL

x

x

x

x

x

x

x

CAPS

x

x

x

x




CHANGE


x

x

x




CUT


x

x





DELETE


x


x




DOWN

x

x

x

x

x

x

x

E

x

x


x




EDIT

x

x

x

x


x


END

x

x

x

x

x

x

x

EXCLUDE ALL

x

x

x





EXECUTE






x


EXPAND

x

x

x



x


FADB2





x



FIND

x

x

x

x



x

FLIP

x

x

x





GO






x

x

GRAPHIC

x

x

x

x



x

HELP

x

x

x

x

x

x

x

HEX

x

x


x




HIDE

x

x

x

x




HOLD

x

x

x

x




INFO

x

x

x

x

x

x

x

INSERT


x


x




JUMP

x

x

x

x




KEYLIST







x

KEYS

x

x

x

x

x

x

x

LEFT

x

x

x


x



LOCATE

x

x

x

x


x

x

MAX

x

x

x

x




MAXCOL

x

x

x

x




MEMORY

x

x






MIN

x

x

x

x




MODE






x

x

NEXT

x

x


x




PASTE


x

x





PATH

x

x

x

x




PREV

x

x


x




PRINTDS

x

x

x

x




PRINTP

x

x

x

x




PROFILE

x

x

x

x




RBROWSE

x

x

x

x




RCHANGE


x

x

x




REDIT

x

x

x

x




REPEAT


x


x




RESET

x

x

x

x




RETRIEVE

x

x

x

x

x

x

x

RETURN

x

x

x

x

x

x

x

RFIND

x

x

x

x




RI 2


x


x




RIGHT

x

x

x


x



ROW

x

x

x





ROWH

x

x

x





SAVE


x

x

x

x



SCHEMA3





x



SIZE

x

x




x


SORT

x

x

x

x

x

x

x

SPLIT

x

x

x

x

x

x

x

SQL

x

x



x

x


SQLID

x

x

x

x

x

x

x

SWAP

x

x

x

x

x

x

x

TABLE

x

x


x




TEMPLATE

x

x






TOP

x

x

x

x

x

x

x

UDT

x

x

x

x


x

x

UDTSWAP






x

x

UDTTYPE






x

x

UP

x

x

x

x

x

x

x

V

x

x


x




WRAP

x

x

x





XLOB

x

x


x




ZOOM

x

x

x





ZOOMH

x

x

x





  • 1: Unless otherwise noted, commands are available in SQL Source Analysis only.
  • 2: Valid only from the RI Browse window.
  • 3: Valid only from the SQL Plan Analysis option.

Important

The following commands have been replaced by Object Administration functionality: ALTER, ATOMIC, COLCHECK, CREATE, DEFAULT, FOREIGN, GRANT, IDENTITY, MODIFY, NAMCHECK, PARMS, PARTITN, PRIMARY, REMARKS, RETPARM, REVOKE, RUNOPTS, SRCPARM, UDFOPTS, VALUES and WHENCOND. For more information, see Getting-started-with-File-AID-for-Db2-object-administration.

The primary commands are listed alphabetically. Parentheses enclose command abbreviations. If no syntax is shown for a command, the command accepts no parameters.

ADD

Adds a new application relationship to the relationship file. Valid only in Related Table Browse and Edit and Option 6, Relationships.

BOTTOM (BOT)

Displays the last line of data in a selected object.

BROWSE (BRO)

Initiates a multiple browse session from a browse or edit session. The tables do not have to be related. In Option 3.4 (Object List Processing) and Option 4 (SQL Analysis), the BROWSE command will display Db2 catalog data when entered from a table, index, or trigger object information panel.

CANCEL (CAN)

Cancels the current activity or discards edits made since the last save.

CAPS

ON converts lowercase text to uppercase letters.

image2021-4-12_15-47-30.png

CHANGE (C)

Changes a value. If you do not enter a column name, the change is applied to all columns. Without the ALL parameter, only the first occurrence of a value is changed starting at the cursor position. Entering CHANGE with no parameters displays a selection window.

image2021-4-12_15-48-5.png

See Partial Column Names for information on specifying column name.

CUT (CU)

Appends one or more rows from a table into the paste buffer. CUT REPLACE overwrites the current paste buffer. Valid only in Edit table mode.

image2021-4-12_15-53-16.png

DELETE (DEL)

Deletes one or more rows from a table. Valid only in Edit row mode.

image2021-4-12_15-52-55.png

DOWN

Scrolls down by the specified amount.

image2021-4-12_15-52-30.png

E

The E command displays the Edit Column Data screen for the selected column. There, you can edit the column data of one row in character image. Specify the desired column with its column number as it is displayed on the row mode screen, or place the cursor on the target column before you press ENTER. Valid only for character type column in Edit row mode.

image2021-4-12_15-53-43.png

EDIT (ED)

Initiates a multiple edit session from a browse or edit session. The tables do not have to be related.

END

Ends the current File-AID for Db2 activity and takes you back to the previous screen.

EXCLUDE (X)

Excludes rows from an Edit display.

image2021-4-12_15-54-21.png

EXECUTE (EXEC)

Processes your request for data selection.

EXPAND

The EXPAND command enables you to view the full content of a scrollable field in a separate window.

FADB2

Blank executes the indicated SQL Analysis line command: BR, ED, EX, or XP. BOUNDS returns a message stating the status of column boundaries. Entering column positions sets new column boundaries. Valid only from the SQL Analysis Edit screen.

image2021-4-12_15-54-56.png

FIND (F)

Searches for occurrences of a specified value within a column, displays a message stating the total number, and moves the cursor to the first occurrence. If you do not specify a column name, the search applies to all columns. Without the ALL parameter, only the first occurrence of a value is found starting at the cursor position. Entering FIND with no parameters displays a selection window.

image2021-4-12_15-55-24.png

See Partial Column Names for information on specifying column name.

FLIP

Makes excluded rows visible and visible rows excluded. You must have excluded rows in the Edit display for this command to be effective.

GO (G)

Submits an extract or load request from either the “Extract DB2 - Driving Object”, “LOAD - SQL Insert”, or “LOAD - DB2 Load” panels.

GRAPHIC (GR)

Displays a graph of the tables related to the table you are browsing or editing.

HELP

Invokes the File-AID for Db2 help facility, causing a help screen or message to be displayed. When an SQL error is displayed, the HELP command provides the Db2 SQL error text returned from Db2.

HEX

Displays data in hexadecimal format. Valid in zoom and row mode.

HIDE

Causes one or more columns to be hidden from a Browse or Edit display. Entering HIDE with no parameters displays a column selection list. Columns remain hidden until the RESET command is issued.

image2021-4-12_15-59-36.png

See Partial Column Names for information on specifying column name.

HOLD

Causes one or more columns to be fixed to the left side of the table mode screen or to the top of the row mode screen. Entering HOLD with no parameters displays a column selection list. Columns remain held until the RESET command is issued.

image2021-4-12_16-0-4.png

See Partial Column Names for information on specifying column name.

INFO

Displays the current File-AID for Db2 Location ID, Subsystem ID, SQL ID, User ID, Plan name, ISPF applid, and File-AID for Db2 and Db2 versions.

INSERT (INS)

Inserts one or more new rows into a table. Valid only in Edit row mode.

image2021-4-12_16-0-52.png

JUMP (J)

Allows you to edit another table when editing multiple tables. When you jump to a new window, it becomes active. Defaults to the next sequential window.

image2021-4-12_16-1-16.png

KEYLIST

Enter the ISPF Key List utility. ON and OFF valid only with ISPF 4.1 or above.

image2021-4-12_16-1-39.png

KEYS

Displays the default PF key settings.

LEFT

Scrolls left by the specified amount.

image2021-4-12_16-2-5.png

LOCATE (L)

In Browse or Edit mode, scrolls the screen to position the display at a specified column. Entering LOCATE with no parameters displays a column selection list.

image2021-4-12_16-2-31.png

See Partial Column Names for information on specifying column name.

From an object list, searches for a value in a selection list.

image2021-4-12_16-2-57.png

MAX

Enlarges a window to the maximum screen size when viewing multiple tables.

MAXCOL

The MAXCOL command sets the maximum width of the columns in the Db2 table being browsed or edited to the value specified. This command only affects the following column data types: CHAR, VARCHAR, LONG VARCHAR, GRAPHIC, VARGRAPHIC, LONG VARGRAPHIC, BLOB, CLOB, and XML. MAXCOL for a Db2 table defaults to OFF.

When you set MAXCOL in a browse or edit session (or related browse/edit), that setting is retained across sessions. So, if you exit a session and then later start a new session, the setting remains the same. You can change the setting from the browse/edit screen, or from Option 0, Defaults and User Parms, at the Primary Option Menu.

image2021-4-12_16-3-23.png

Note

If MAXCOL is set when a FIND, RFIND, CHANGE or RCHANGE command is executed, File-AID for Db2 turns MAXCOL to OFF.

MEMORY (MEM)

The MEMORY command allows you to provide information to File-AID for Db2 so that the proper amount of memory can be used to execute specific commands. MEMORY is available from the following screens:


    • Edit Options
    • Browse Options

image2021-4-12_16-3-58.png

MIN

Reduces a window to its original size when viewing multiple tables. You can then resume viewing multiple tables.

MODE

The MODE command switches the extract or load execution mode from BATCH (default) to ONLINE or from ONLINE back to BATCH. MODE acts as a toggle switch. Valid in the “Extract DB2 - Driving Object” and “LOAD - SQL Insert” panels.

NEXT (N)

Scrolls the display from the current row to the next row. MAX scrolls to the last row in the table. Valid only in row mode.

image2021-4-12_16-4-20.png

PASTE (PAS)

Copies one or more rows from the paste buffer into a table or data set. Valid only in Edit table mode.

image2021-4-12_16-4-40.png

PATH

Switches to another dependent table path from the current parent table. Valid only in Related Edit mode.

image2021-4-14_16-11-58.png

PREV (P)

Scrolls the display from the current row to the previous row. MAX scrolls to the first row in the table. Valid in row mode.

image2021-4-14_16-12-38.png

PRINTDS (PRTDS)

Prints rows displayed or specified on the screen, or in a table or view. Output is appended to the data set that you specify in Option 0.7, Print Options.

image2021-4-14_16-13-9.png

PRINTP (PRTP)

Prints one or more rows to the printer specified in Option 0.7, Print Options.

image2021-4-14_16-13-42.png

PROFILE (PRO)

Displays a window with your current profile options and allows you to change them. See User Profile Defaults for a list of options you can set with this command.

RBROWSE (RB)

Initiates a Related Browse session. Browses the table related to the table you are browsing or editing. Specifying ADD allows you to add a new application relationship.

image2021-4-14_16-29-23.png

RCHANGE

Repeats the execution of the previous CHANGE command.

REDIT (RE)

Initiates a Related Table Edit session. Edits the table related to the table you are browsing or editing. Specifying ADD allows you to add a new application relationship.

image2021-4-14_16-29-51.png

REPEAT (REP)

Adds one or more duplicate rows to a table. Valid only in row mode. If Repeat Command Prompt Option of the PROFILE command is set to ON, and the table does not contain Unicode table data, the REPEAT Column Range Specification window appears.

image2021-4-14_16-30-20.png

RESET (RES)

Restores hidden and held columns, and excluded and blank inserted lines. Entering RESET with no parameters displays a column selection list.

image2021-4-14_16-31-8.png

See Partial Column Names for information on specifying column name.

RETRIEVE

Redisplays the last command entered in the COMMAND field.

RETURN

Returns to the File-AID for Db2 Primary Option Menu or to the screen displayed when you entered the HELP command.

RFIND

Repeats the execution on of the previous FIND command.

RI

Resolves referential integrity errors. Valid only in RI Browse row mode.

RIGHT

Scrolls to reveal data to the right of the display.

image2021-4-14_16-33-46.png

ROW

Switches a Browse or Edit display from table to row mode. Position cursor on row to be displayed before pressing Enter.

ROWH

Switches a Browse or Edit display from table to hexadecimal row mode. Position cursor on row to be displayed before pressing Enter.

SAVE

Makes your editing changes permanent.

SCHEMA

The SCHEMA command changes the value of the CURRENT SCHEMA during an SQL Analysis session, without returning to the User Parms menu. When you enter the SCHEMA command, the same screen is displayed as when you select CURRENT SCHEMA from the Special Registers Values menu.

image2021-4-14_16-34-14.png

SIZE

The SIZE command provides an alternate display of the selection template in a browse/edit, extract or print session. It 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.

image2021-4-14_16-34-40.png

SORT

In Browse or Edit, sorts the rows of a table by the specified column. Entering SORT with no parameters displays a column selection list. Defaults to sorting only non-excluded rows. Specify ALL for all rows.

image2021-4-14_16-36-13.png

See Partial Column Names for information on specifying column name.

From an object list, sorts the list by the specified criteria.

image2021-4-14_16-36-39.png

You can also issue SORT on SQL Development and Analysis selection screens.

SPLIT

Divides the display screen, letting you run two sessions simultaneously.

SQL

Presents the Db2 SQL statements generated for the displayed screen.

SQLID

Sets your SQLID to a new value.

image2021-4-14_16-37-14.png

SWAP

Moves the cursor to the last position it occupied in the opposite screen of a split-screen session.

TABLE (TAB)

Switches a Browse or Edit display from row mode to table mode.

TEMPLATE (TEMP)

The TEMPLATE (TEMP) command is available in the Edit SQL Selection screen when accessed with Edit (or Browse) Options Temporary Selection Criteria usage=T and Criteria Display Format=T. Use the TEMPLATE command to display the Edit Selection Template screen populated with the current SQL SELECT statement.

TOP

Displays the first line of data in a selected object.

UDT

Displays the schema.name and its built-in datatype for the selected User Defined Type (UDT) column (cursor position). Edit/Browse only.

image2021-4-14_16-37-59.png

UDTSWAP

Swaps the display for distinct type columns from UDT name to the built-in data type and length and vice versa. Valid only on the (Extract) “DB2 Object Selection Criteria” screen.

UDTTYPE

Lists all distinct data types (UDTs) that are part of the extract. The list displays the schema, UDT name, and the built-in data type and length. Valid only on the (Extract) “DB2 Object Selection Criteria” screen.

UP

Scrolls up by the specified amount.

image2021-4-14_16-38-29.png

V

The V command displays the Edit Column Data screen for the selected Unicode column. The entire value of the column is displayed vertically with one character per line. There, you can edit the column data of one row in hexadecimal image. Each character is identified by its Unicode hex value and its description. Specify the desired column with its column number as it is displayed on the row mode screen, or place the cursor on the target column before you press ENTER. Valid only for Unicode column in Edit row mode.

image2021-4-14_16-38-54.png

WRAP

ON or nnnn wraps column data so it is visible without scrolling left or right. Valid in table mode only, after issuing a ZOOM or ZOOMH command.

image2021-4-14_16-39-19.png

XLOB

XLOB n retrieves the entire data record of the target LOB column (CLOB, BLOB, or DBCLOB) into a temporary work file and starts a File-AID/MVS browse or edit session to allow you to browse or edit the work file data. The XLOB SET command displays the XLOB Work File Allocation Parameters window where you can change the work file allocation attributes. Valid in browse and edit row mode only.

image2021-4-14_16-39-43.png

ZOOM

Allows viewing of a specific column in character format. Valid only in table mode.

image2021-4-14_16-40-10.png

See Partial Column Names for information on specifying column name.

ZOOMH

Allows viewing of a specific column in hexadecimal format. Valid only in table mode.

image2021-4-14_16-40-38.png

See Partial Column Names for information on specifying column name.

 

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