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.

File-AID for DB2 Interface


The following provides procedures for activating the File-AID for Db2 Interface. The interface allows access to File-AID for Db2 Browse and Edit from external sources other than Compuware products.

Activating the Interface

The CLIST F2XNTRFC provides the File-AID for Db2 Interface. It is located in your hlq.SXVJCLIB library. Values must be provided for the parameters listed below. Typically, you invoke F2XNTRFC through other products or user interfaces.

F2XNTRFC Parameters

Note

You must enter quotes around the value for each parameter. The number of quotes depends upon how ISPF is installed at your site. Refer to the ISPF Dialog Developer’s Guide and Reference for more information.

OPTION

File-AID for Db2 option you want to invoke:

BROWSE

Accesses File-AID for Db2 Browse. Default.

EDIT

Accesses File-AID for Db2 Edit.

ENTRY

Entry option for Browse or Edit:

FULL

Accesses Browse or Edit directly for the object specified in the QUAL and NAME variables. Default.

SPUFI

Accesses Browse or Edit using the SQL passed in the SQL variable to determine the result table.

TEMPLATE

Accesses the Template Selection Panel for the object specified in the QUAL and NAME variables.

NAME

Name of the Db2 object to browse or edit. This parameter is ignored if SPUFI is specified for the ENTRY parameter. Maximum length is 128.

Note

Temporal tables can be accessed as regular tables for browse or edit. If you want to use system dates, you need to prepare an SQL statement for that and use it in the CLIST interface with SQL variable (see also SQL).

Here is an example of the SET &SQL statement. Note the ending – on each line denotes continuation of the SQL statement:

SET &SQL = &STR( -                                       
SELECT * -                                               
FROM FADB2610.POLICY_SYS -                               
FOR SYSTEM_TIME FROM CURRENT TIMESTAMP - 5 YEARS -       
TO CURRENT TIMESTAMP -                   
WHERE ID = 1111)      

QUAL

Qualifier of the object specified in the NAME parameter. This parameter is ignored if SPUFI is specified for the ENTRY parameter. Maximum length is 128.

SSID

Db2 Subsystem Identification. Maximum length is four.

SQLID

Db2 SQLID. Maximum length is eight.

SQL

SQL statements that produce the result table to browse or edit. If specified, the QUAL and NAME parameters are ignored. Maximum length is 2048.

MAXROW

Maximum number of rows to select for browse or edit. Valid values are 1 through 99999, or ALL to specify all rows. Maximum length is five. Default is 2000.

LOCNAME

Location at which the table to be accessed, resides. This option is introduced so that if the location of the table is known, but the subsystem in which the table exists is unknown, the user can get to the table.

Optional Parameters

The following two parameters are optional. They are typically used when debugging or modifying the CLIST.

TRACE

Determines if the CLIST execution appears:

TRACE

displays the CLIST execution on the screen.

NOTRACE

suppresses the display of the CLIST execution on the screen. Default.

LIBDEF

Determines how the File-AID for Db2 and Db2 data sets are allocated:

Y

File-AID for Db2 and ISPF libraries are allocated with the ISPF ALTLIB and LIBDEF facilities.

N

File-AID for Db2 and ISPF libraries are allocated prior to invoking the CLIST.

Sample Entry CLIST

The CLIST F2XNSAMP, located in hlq.SXVJCLIB, is provided as a sample entry CLIST. It sets values to the parameters and calls F2XNTRFC. By default, the CLIST will use the “Simple Deploy” method to allocate File-AID data set names as specified with FANODE(PARMLIB) and default CMSC PARMLIB member DDSNnnnn as specified in your site’s CMSC start-up. When using a different DDSN suffix, just update the DDSNSFX() with the suffix, for example DDSNSFX(CPWR) points to DDSNCPWR.

The “Simple Deploy” method requires Enterprise Common Components (ECC) Release 17.02, with all current maintenance applied.

Follow the instructions in the member to reflect your environment.

The comments in the member also provide instructions when you choose NOT to use the “Simple Deploy” method.

 

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