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.

Starting a Browse or Edit Session


To access the Browse function, select option 1, Browse, from the Primary Option Menu. To access the Edit function, select option 2, Edit, from the Primary Option Menu. The Browse or Edit Option screen displays (Edit (or Browse) Options screen).

Important

The Edit Options screen and the Browse Options screen are the same except for the following differences: Different screen titles, the Lock Table and Audit Trail options do not appear on the Browse Options screen, and you cannot enter 0 for insert in the Maximum Rows to Select field on the Browse Options screen.

Edit (or Browse) Options screen

image2021-3-10_11-12-11.png

Specify Db2 Table Area

Location ID

Optional. Location of the table or view you plan to edit. Specify a value if you want to browse or edit a table not at your current location. Wildcard characters (*, _, %) are valid. See Wildcard-Characters for more information.

If you enter a wildcard character in this field, the Location Selection pop-up (Location Selection Window) displays.

Important

File-AID for Db2 must be installed on the remote Db2 subsystem with packages. DDF must have been installed for your current subsystem or you receive the error message Location name not in use.

Creator

ID of the person who created the table or view you plan to edit. Wildcard characters
(*, _%) are valid. See Wildcard-Characters for more information.

If you enter a wildcard character in this field, the Edit Table List (Edit Table List Window) displays.

Table Name

Name of the object you want to edit. Tables, aliases, synonyms and views are valid. Wildcard characters (*, _%) are also valid. See Wildcard-Characters for details.

If you enter a wildcard character in this field, the Edit Table List (Edit Table List Window) displays.

Optional Area

Important

Specifying an optional database and/or tablespace is only in effect when the Creator field or the Table Name field contain an asterisk.

Database

Name of the database to which you want to confine your selection list.

Tablespace

Name of the tablespace to which you want to confine your selection list.

Specify Selection Criteria Information Area

Selection Criteria Usage

Specify whether you want to use a previously saved selection criteria dataset. Selection criteria consists of conditions to limit and order column selection and/or row selection based on column values.

Specify the letter that represents the activity you want to perform:

T

Create Temporary selection criteria. The Criteria Display Format field determines the format used for the criteria.

M

View or modify existing saved selection criteria. The criteria contained in the selection criteria dataset is displayed in the format specified by the Criteria Display Format field.

E

Execute existing saved selection criteria. The criteria is not displayed.

N

Do not apply selection criteria. All rows for the object are displayed.

Criteria Display Format

Specify whether selection criteria is to be entered on the Template, or as native SQL. This field only applies when the Selection Criteria Usage field is T (Temporary), or M (Modify).

Specify the letter that represents the activity you want to perform:

T

Selection criteria is processed using the Template. If the SQL is unable to be parsed for display on the Template, then a pop-up window displays stating that the SQL cannot be parsed and asks if you want to view the native SQL.

S

Selection criteria is processed in Edit using native SQL.

Criteria Dataset Name

If you specify M (Modify) or E (Existing) Selection Criteria Usage, specify an existing sequential or partitioned dataset with RECFM=FB and LRECL=80. File-AID for Db2 prefills this field with the name of the last specified selection criteria data set.

If you specify T (Temporary) Selection Criteria usage, a temporary data set (hlq.userid.SYSyyddd.Thhmmss.SHOW.SQL) containing the SQL source is created. An ISPF edit session is initiated, enabling you to edit the SQL. If you want to save the SQL source, you must use the ISPF CREATE or COPY command to a permanent data set before exiting the edit session. The temporary data set will be deleted when returning to the Edit (or Browse) Options screen.

Member

Specify the member of the data set you want to use. The field is prefilled with the last specified member name. If you leave this field blank or specify an asterisk (*), File-AID for Db2 displays the Member List for the data set. Specify a pattern, for example PART*, to narrow down the member list to the matching member names. The asterisk (*) is the only valid pattern character.

Specify Edit Options Area

Initial Display Mode

Enter the desired initial display mode. This field is updated with the last mode in use before exiting your edit session.

1

Displays multiple rows per screen. Column names are listed across the top of the screen. This is called table mode.

2

Displays one row per screen. Column names are listed down the left side of the screen and column data is listed down the right side of the screen. This is called row mode.

See Display-Modes for more information.

Lock Table During Edit

Indicate whether you want exclusive access to the table during Edit. (See Locking a Table During Edit for more information.)

Use Uncommitted Read

Specify whether to enable retrieval of uncommitted data for the browse or edit session. The field is prefilled with the last specified value (YES or NO) or as specified with the UNCOMMITTED_READ_DEFAULT parameter of the Db2 Environment PARMLIB member. For more information, see UNCOMMITTED_READ_DEFAULT in the Db2 environment.

NO

Only retrieve committed data from tables without write locks. Even if your selection criteria SELECT statement includes a WITH UR clause, it is not honored.

YES

Retrieve data, including data not yet committed by another user or application. The SELECT statement which File-AID for Db2 uses to get table data into edit/browse has the suffix WITH UR appended. This allows reading through any locks which may be held on that table.

Maximum Rows to Select

Specify a numeric value indicating the maximum number of rows to be selected, or specify an asterisk (*) to select all rows. The default value is retrieved from User Parms (Option 0). See Browse-Edit-SQL-Analysis-Display-Options for information on changing the default. See Maximum Rows to Select for more information on this field.

SELECT FROM Temporal Table

Enter Yes if you want to specify or modify a time-period and date/timestamps for temporal tables or Temporal Views. File-AID will display the SELECT FROM Temporal Table screen (refer to SELECT FROM Temporal Table) when you press Enter. Temporal table support requires Db2 Version 10 or more recent. Starting with Db2 Version 11, temporal support allows period specifications and period clauses to be specified for views. The same rules apply for views as do for tables.

Enter No (default) if you don’t want to display the SELECT FROM Temporal Table screen.

The status *Defined* displays if a SELECT FROM Temporal Table statement has already been defined, otherwise *None* displays.

Important

  1. When the *Defined* status displays and the selected table is a temporal table, File-AID for Db2 will include the SELECT FROM Temporal Table statement even if the SELECT FROM Temporal Table field is set to N.
    The SELECT FROM Temporal Table statement is only generated for a Temporal Table or Temporal View.
  2. Whenever the selection is based on SYSTEM_TIME, it is possible that some rows come from the base table and some from the history table. As the Edit session does not know which row came from which table, Edit is not supported and the session switches to Browse.
  3. During an Edit session of the base table of a SYSTEM_TIME managed temporal table (SELECT FROM Temporal Table *None*), the columns used to store the SYSTEM_TIME PERIOD will be protected for data entry. Db2 will populate the history table based on changes made to the base table.
  4. During an Edit session of a BUSINESS_TIME managed temporal table, the columns used to store the BUSINESS_TIME PERIOD will be protected for data entry.
  5. The SELECT FROM Temporal Table field will be reset to its default (NO, *None*) when you exit the product. File-AID does not save your SELECT FROM Temporal Table definition from session to session.

Create Audit Trail

Indicate whether you want to create an audit trail for your Edit session. This field may not be present on your screen. See Creating an Audit Trail Dataset for a detailed explanation of this feature.

Relationship File

Optional. Enter the name of the file that stores your relationship definitions. You must specify this file to browse or edit related tables. See Related-Table-Browse-and-Edit-function for more information.

Memory Utilization Window

The Memory utilization window allows you to provide information to File-AID for Db2 so that the proper memory utilization for your actions will be obtained.

Warning

The Memory Utilization window is an advanced user option and should be used with caution.

The Memory Utilization window (see the following figure) is displayed when you enter the MEMORY command from the Edit Options or Browse Options screen.

Memory Utilization Window

image2021-3-10_11-17-1.png

There are two areas that require larger memory than others: The Expansion area for new rows, and the Work area for commands.

Expansion area for new rows

When you use the INSERT, REPEAT, COPY and PASTE commands to add new rows to a table, an area in memory is required to expand for the new rows. This area is called the Expansion area. For most users, the default values are acceptable and will allow commands to be processed as needed.

The Expansion area for new rows field allows you to specify the percentage of available memory to be used for new rows. Use the following as a guide to specify this percentage:

10

Default. Small percentage allows the most data to be loaded and allows a minimal number of rows to be inserted or repeated.

20

Medium percentage allows a larger number of rows to be inserted or repeated but less data will be loaded.

30

Large percentage allows a large number of rows to be inserted or repeated, or multiple nested browse or edit sessions or Related browse or edit sessions.

nn

Customized amount. Specify a number from 5 to 60.

Important

Specify a small expansion area first, and then increase as needed.

If you try adding more rows than the expansion area can accommodate, the command fails and the error message “Insufficient Memory” is displayed. If you press PF1, the longer error message is displayed, which indicates approximately how many rows can be added. You can execute the command again, based on the amount of memory available, or start the session again with fewer rows.

Specifying Selection Criteria or a smaller number for Maximum Rows to Select may reduce the number of rows to be processed and leave more room for adding data. You can also specify a larger value for the expansion area, which may indirectly cause fewer rows to be loaded.

Work area for commands

The Work area for commands field allows you to influence whether File-AID for Db2 will begin to process your command or not. For most users, the default values are acceptable and will allow commands to be processed as needed. However, the commands REDIT, RBROWSE, GRAPHIC, SORT, and multiple nested edit and browse sessions require a larger work area in memory.

Specify this value in number of kilobytes (K). In other words, when you specify 3000, you are specifying 3000K. If the memory size specified is not available, the command fails and the error message “Insufficient Memory” is displayed.

Important

There is an inverse relationship between the Expansion area for new rows and the Work area for commands fields. As more memory is obtained for new rows and commands, fewer rows of data can be read into memory to be processed.

Save these values

Allows you to specify if the changed values are to be saved and used in the future. Default is N (No). If you specify N, the changed values will apply only to the current edit or browse session, until you return to the Edit Options or Browse Options screen. If you specify Y, the changed values are saved until you change the values again.

Location Selection Window

The Location Selection window displays if you type an asterisk or wildcard character in the Location field on the Edit Options screen. The window provides you with a list of locations to be selected. If you press END from this window without selecting a location, File-AID for Db2 uses the current location.

Location Selection Window

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

Cmd

Enter the S line command to select one of the listed remote location names.

Location Name

Lists all defined Db2 remote location names.

Selection Criteria Member List

The Selection Criteria Member List displays if you left the Selection Criteria Member field on the Edit Options screen blank or entered a * pattern. It provides a list of members of the specified Selection Criteria data set.

Member Selection Criteria List screen

image2021-3-10_11-20-43.png


Sel

Enter the S line command to select one of the listed members as your selection criteria.

Member Name

Lists all member names of the selection criteria data set.

Edit Table List

The Edit Table List window displays when you enter a wildcard character in the Creator and/or Table Name field on the Edit Options screen. It provides a list of tables or views to be selected for browsing or editing.

Edit Table List Window

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

Cmd

Enter S to select the table or view.

Creator

Lists creator IDs of the tables to be selected.

Table

Lists the tables to be selected.

Type

Object type for each object listed (TABLE, VIEW, ALIAS, HIST, IDAA, or ARCHV).

SELECT FROM Temporal Table

The SELECT FROM Temporal Table window displays when you enter Y in the SELECT FROM Temporal Table field. It allows you to construct the SELECT FROM statement to be used for a temporal table (or view starting with Db2 Version 11) to be browsed (System Period and Business Period) or edited (Business Period only).

SELECT FROM Temporal Table

image2021-3-10_11-22-11.png

A temporal table records the period of time when a row is valid. Db2 supports two types of periods, the application period (BUSINESS_TIME) and the system period (SYSTEM_TIME).

System Period

The system period consists of a pair of columns with system-maintained values that indicate the period of time when a row is valid. The system period is meaningful because you can define system-period data versioning on a table that has this period. System-period data versioning specifies that old rows are archived into another table. The table that contains the current active rows of a table is called the system-period temporal table. The table that contains the archived rows is called the history table (Table Type=H). You can delete the rows from the history table when those rows are no longer needed, if you have the proper authorization.

When you define a base table to use system-period data versioning, or when you define system-period data versioning on an existing table, you must create a history table, specify a name for the history table, and create a tablespace to hold that table. You define system-period data versioning by issuing the ALTER TABLE ADD VERSIONING statement with the USE HISTORY TABLE clause.

Application (Business) Period

A business (application) period consists of a pair of columns with application-maintained values that indicate the period of time when a row is valid. A table with only a business period is called an application-period temporal table.

Bitemporal Table

A bitemporal table is both a system-period temporal table and an application-period temporal table. You can use a bitemporal table to keep application period information and system-based historical information. Therefore, you have a lot of flexibility in how you query data based on periods of time.

For each System Time and Business Time, specify the time period to be used to select rows from a temporal table.

Use System Time

Specify Yes if the table includes System Time and you want to select rows from the specified period.

Note

Whenever System Time is set to Yes, Edit is not supported and the session switches to Browse for a system-period temporal table. Set System Time to No to enable editing of a system-period temporal table.

Time period

Select the period method you want to specify for System Time:

1

AS OF creates the AS OF ... period statement to select valid rows as of a certain point in time. This option requires you to also specify a value for Date/Timestamp 1. Example statement:

FROM table FOR SYSTEM_TIME AS OF TIMESTAMP('2012-03-16-00.00.01') 

2

FROM creates the FROM ... TO ... period statement to select valid rows from a certain time to a certain time. FROM is inclusive, TO is exclusive. That means, the specified start time is included in the period but the specified end time is not. This option requires you to also specify a value for Timestamp 1 (start time) and Timestamp 2 (end time). Example statement:

FROM table FOR SYSTEM_TIME FROM TIMESTAMP('2011-03-16-00.00.01')
TO TIMESTAMP('2012-03-16-00.00.01') 

3

BETWEEN creates the BETWEEN ... AND ... period statement to select valid rows from a certain time to a certain time. BETWEEN and AND are inclusive. That means, that both the specified start time and end time are included in the period. This option requires you to also specify a value for Timestamp 1 (start time) and Timestamp 2 (end time). Example statement:

FROM table FOR SYSTEM_TIME BETWEEN TIMESTAMP('2011-03-16-00.00.01')
AND TIMESTAMP('2012-03-16-00.00.01') 

Timestamp 1

Specify the corresponding start timestamp for the selected system time period.

Timestamp 2

Specify the corresponding end timestamp for the selected system time period. Only required for FROM and BETWEEN periods.

Use Business Time

Specify Yes if the table includes Business Time and you want to select rows from the specified period.

Time period

Select the period method you want to specify for Business Time:

1

AS OF creates the AS OF ... period statement to select valid rows as of a certain point in time. This option requires you to also specify a value for Date/Timestamp 1. Example statement:

FROM table FOR BUSINESS_TIME AS OF DATE('2011-03-16') 

2

FROM creates the FROM ... TO ... period statement to select valid rows from a certain time to a certain time. FROM is inclusive, TO is exclusive. That means, the specified start time is included in the period but the specified end time is not. This option requires you to also specify a value for Timestamp 1 (start time) and Timestamp 2 (end time). Example statement:

FROM table FOR BUSINESS_TIME FROM DATE('2011-03-16') TO CURRENT DATE 

3

BETWEEN creates the BETWEEN ... AND ... period statement to select valid rows from a certain time to a certain time. BETWEEN and AND are inclusive. That means, that both the specified start time and end time are included in the period. This option requires you to also specify a value for Timestamp 1 (start time) and Timestamp 2 (end time). Example statement:

FROM table FOR BUSINESS_TIME BETWEEN DATE('2011-03-16') AND
CURRENT DATE 

Date/Timestamp 1

specify the corresponding start date/time for the selected business time period.

Date/Timestamp 2

specify the corresponding end date/time for the selected business time period. Only required for FROM and BETWEEN periods.

Important

If the arguments for business Date/Timestamp 1/2 include only date information, the time information in the result value is all zeros. This means that date value of '2000-10-31' will result in a TIMESTAMP of '2000-10-31-00.00.00'. This could result in different rows being returned than if a user entered '2000-10-31-23.59.59'.

 

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