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.

Batch Facility function


This section describes the File-AID for Db2 Batch Facility. The Batch Facility allows you to execute SQL in batch mode under the control of File-AID for Db2. Any SQL that can be executed dynamically can execute in File-AID for Db2 batch. From the Batch Facility, you can identify the location of existing SQL, or invoke an ISPF Edit session and update SQL or code new SQL to then be executed. File-AID for Db2 does not provide any assistance in SQL creation.

When the SQL contains UPDATE or DELETE processing, you can specify the interval at which COMMIT processing is invoked. No change is required to the SQL; File-AID for Db2 will transform the SQL before execution so that the COMMITs can be executed as required. This COMMIT processing reduces the impact of running an SQL statement that affects many rows.

Important

Restart is not provided when running the Batch Facility. we recommend that before the Batch Facility job is run, you take an image copy of all tables to be updated. If the job fails, you can use the image copy to restore the tables.

Create Trigger Statement

If you issue a CREATE TRIGGER statement, you must precede it with a #SET TERMINATOR control statement to set the SQL terminator to a value other than semi-colon. The pound sign (#) is recommended. Then, follow it with another #SET TERMINATOR control statement to reset the SQL terminator back to semi-colon.

Example:

--#SET TERMINATOR #
CREATE TRIGGER userid.trigger_name
            AFTER UPDATE
            OF column1, column2
            ON userid.table_name
            FOR EACH ROW MODE DB2SQL
            WHEN when-clause
            BEGIN ATOMIC
                SQL statement;
                SQL statement;
             END #            
            --#SET TERMINATOR ;
Warning

If you do not precede and follow the CREATE TRIGGER statement with a --#SET TERMINATOR control statement, the CREATE TRIGGER statement may produce unpredictable results.

Refer to the IBM Database 2 SQL Reference, CREATE TRIGGER section, for more information.

Accessing the Batch Facility

Access the Batch Facility from the File-AID for Db2 Primary Option Menu or the Utility Selection Menu. To start the Batch Facility from the File-AID for Db2 Primary Option Menu, select option 3.9. To start the Batch Facility from the Utility Selection Menu, select option 9.

The following figure illustrates option 3.9 on the File-AID for Db2 Primary Option Menu.

 File-AID for Db2 Primary Option Menu

image2023-2-24_18-26-27.png

Batch Execute SQL

When you select option 3.9 from the File-AID for Db2 Primary Option Menu, the Batch Execute SQL screen is displayed. The Batch Execute SQL screen lets you specify the location of the SQL, processing options, and print options. See the following figure.

Batch Execute SQL

image2021-3-11_17-3-38.png

Specify SQL Dataset

Edit SQL

Specify whether or not you want to make changes to the SQL dataset.

If you enter NO in this field, you must have a location where the SQL is saved in a data set. If you enter YES and you leave the Dataset name blank, a temporary PDS member along with a warning will display. In the temporary PDS member you can enter the SQL. The warning message indicates that the SQL you have entered will not be saved. If you enter YES and a dataset name and an existing member name, then you are able to edit the PDS member.

Dataset name

Name of the data set in which the SQL resides. The data set can be sequential or partitioned and must have a record length of 80. If the record length is not 80, an error message is displayed. Type the Data set name completely with or without quotes. If the data set is a PDS, you can also type the member name, following the Dataset name. For example: ‘userid.my.sql(member)’ or my.sql(member).
If you leave Dataset name blank, and you entered NO in the Edit SQL field, then an error message is displayed.

Member

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, if it is a PDS. 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 Processing Options

Create Audit Trail

Indicate whether you want to create an audit trail for your Batch Execute SQL request. This feature is similar to Create Audit Trail for Browse or Edit. This field may not be present on your screen. See Creating an Audit Trail Dataset for a detailed explanation of this feature.

Important

When you set Create Audit Trail to YES, the following Automatic COMMIT settings will not be honored.

Automatic COMMIT Processing

Specify YES to change the frequency (how often) of commits when an UPDATE or DELETE statement is processed. Specify NO for no commits, other than the one commit after each UPDATE or DELETE statement is processed. Also, specify NO when you set Create Audit Trail to YES.

Important

Delete/Update SQL statements with period-clause (FOR PORTION OF BUSINESS_TIME FROM value1 TO value2 and FOR PORTION OF BUSINESS_TIME BETWEEN value1 TO value2) are not supported.

Auto commit row interval

Specify the maximum number of rows before changes are committed. You can enter up to six numeric digits, 0 through 9. The default is 999999. Not applicable when you set Create Audit Trail to YES.

Auto commit time interval

Specify the number of seconds before changes are committed. You can enter up to four numeric digits, 0 through 9. The default is 9999. Not applicable when you set Create Audit Trail to YES.

Important

If you enter both auto commit number of rows AND number of seconds, then the commit will occur at whichever interval is reached first.

SQL Terminator

Character that terminates the SQL statement. This can be any alphanumeric character except for a blank, comma, single or double quote, left or right parenthesis, or underscore. The default is a semicolon.

Specify Print Options for SELECT Statements

Print Mode:

Enter the desired presentation mode for printing. This field is updated with the last mode in use.

1

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

2

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

See Display-Modes for more information.

Print HEX in ROW Mode:

Enter the desired hexadecimal presentation mode for Row mode data printing. This option is ignored if Print Mode is Table.

1

Never print hexadecimal lines.

2

Always print hexadecimal data values right below the character data line.

3

Default. Print hexadecimal data values right below the character data line, if the column data contains non-displayable characters.

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.

Editing SQL

Once you press Enter from the Batch Execute SQL screen, a temporary data set or existing SQL is displayed. Use ISPF edit to modify existing SQL or enter new SQL.

The SQL dataset can include SQL statements, comments, and control statements. SQL statements can span multiple lines. If line numbers are present, they will be ignored. SQL statements must be terminated with a semicolon or the SQL terminator that you specified. You can enter any number of SQL statements.

Comments start with an asterisk (*) in column 1, or two hyphens (--) anywhere on a line. Control statements start with two hyphens anywhere on a line. Comments and control statements cannot span lines.

The control statement ROWS_FETCH controls the number of rows that are processed by the SQL statements that follow. If you do not include a ROWS_FETCH statement, or if you specify the default of -1, then all rows are processed.

Batch Facility Output Specification

The Batch Facility Output Specification screen lets you route the output to a printer or a file. See the following figure.

Batch Facility Output Specification

image2021-3-11_17-8-38.png

You cannot elect to send the report to both destinations. Use the S line command to select the destination and enter the required fields for the appropriate destination. Set the default print options and job statement by selecting option 0, Defaults and User Parameters, from the Primary Option Menu. See Print-Options and Batch-Options.

Once all the parameters have been defined, File-AID for Db2 automatically generates the JCL for the Batch Facility (see Sample Batch Facility JCL (1 of 2)).

Batch JCL from Previous Releases

Migrating JCL from File-AID for Db2 releases 6.3 to Release 21.01 requires removing the File-AID/Common Components (VJ) load libraries CXVJAUTH and SXVJAUTH. See sample JCL in Sample Batch Facility JCL (1 of 2).

Migrating JCL from File-AID for Db2 releases 6.1 or earlier to Release 21.01 requires additional information for COPYTL steps. The CEEOPTS will also need to be copied separately into a temporary passed data set &&CEELIB which is then used in the File-AID Db2 execute step(s). See sample JCL in Sample Batch Facility JCL (1 of 2).

Important

Migrating JCL for File-AID Extract for DB2 (option 3.7.1 on here) and File-AID Load for DB2 (option 3.7.2 on here) does not require the additional information for COPYTL steps.

Sample Batch Facility JCL (1 of 2)

//* JOB CARD
//*
//*
//*
//*-------------------------------------------------------------------
//COPYTL    EXEC PGM=IEBCOPY
//SYSPRINT  DD SYSOUT=*
//SYSOUT    DD SYSOUT=*
//INDD1     DD DSN=hlq.SXVJTENU,
//          DISP=SHR
//INDD2     DD DSN=ISP.SISPTENU,
//          DISP=SHR
//*
//OUTDD     DD DSN=&TBLIBS,
//             DISP=(NEW,PASS,DELETE),
//             SPACE=(TRK,(30,15,15),RLSE),
//             DSNTYPE=LIBRARY,LRECL=80,
//             UNIT=SYSDA
//OUTDD2    DD DSN=&CEELIB,
//             DISP=(NEW,PASS,DELETE),
//             SPACE=(TRK,(30,15,15),RLSE),
//             DSNTYPE=LIBRARY,LRECL=80,
//             UNIT=SYSDA
//SYSUT3    DD UNIT=SYSDA,SPACE=(CYL,(4,4))
//SYSUT4    DD UNIT=SYSDA,SPACE=(CYL,(4,4))
//SYSIN     DD *
  COPY INDD=INDD1,OUTDD=OUTDD
  COPY INDD=INDD2,OUTDD=OUTDD
  COPY INDD=INDD1,OUTDD=OUTDD2
  S M=CEEOPTS
/*
//*-------------------------------------------------------------------
//UTIL EXEC PGM=IKJEFT01,DYNAMNBR=80,REGION=8192K,COND=(7,LT)
//*-------------------------------------------------------------------
//* This is the customized JCL to run TSO from batch.
//* It is imbedded in the skeletons for F2EXTR, F2LOAD, F2ANLBCH,
//* and F2IMPBCH
//*-------------------------------------------------------------------
//STEPLIB  DD DISP=SHR,
// DSN=hlq.CXVJLOAD
//         DD DISP=SHR,
// DSN=hlq.SXVJLOAD
//         DD DSN=DSNA10.DA01.SDSNEXIT,
// DISP=SHR
//         DD DSN=DSNA10.SDSNLOAD,
// DISP=SHR
//*
//CEEOPTS DD DSN=&CEELIB(CEEOPTS),
// DISP=(OLD,DELETE,DELETE)
//ISPPLIB DD DISP=SHR,
// DSN=ISP.SISPPENU
//       DD DISP=SHR,
// DSN=hlq.SXVJPENU
//*
//ISPMLIB DD DISP=SHR,
// DSN=hlq.SXVJMENU
//      DD DISP=SHR,
// DSN=ISP.SISPMENU
//*
//ISPSLIB DD DISP=SHR,
// DSN=ISP.SISPSENU
//       DD DISP=SHR,
// DSN=hlq.SXVJSENU
//*
//ISPTLIB  DD  DSN=&TBLIBS,DISP=(OLD,DELETE,DELETE)
//*
//ISPPROF  DD  DSN=&BATPROF,DISP=(NEW,DELETE,DELETE),
//             DCB=(BLKSIZE=3120,LRECL=80,DSORG=PO,RECFM=FB),
//             SPACE=(TRK,(1,,1)),UNIT=SYSDA
//*
//ISPCTL1  DD  DISP=NEW,UNIT=SYSALLDA,SPACE=(TRK,(5,5,0)),
//             DCB=(LRECL=80,BLKSIZE=6160,RECFM=FB)
//SYSTMP01 DD  DSN=&TMP,
//             DISP=NEW,UNIT=SYSALLDA,SPACE=(TRK,(5,5,0)),
//             DCB=(LRECL=80,BLKSIZE=6160,RECFM=FB)
//SYSTSPRT DD  SYSOUT=*
//SYSTERM  DD  SYSOUT=*
//SYSPRINT DD  SYSOUT=*
//SYSUDUMP DD  SYSOUT=*
//SYSIN    DD  *

Sample Batch Facility JCL (2 of 2)

image2023-2-24_18-27-24.png

The JCL is displayed in a temporary data set. If necessary, modify the JCL using standard ISPF primary and line commands, and then submit the job. The following parameters are included in the JCL:

Parameter

Description

F2SSID

Subsystem ID

FIPLAN

Current plan

CURSQLID

Current SQLID

MODEOPT

Type of printing:
= Table
R = Row

FRGNDISP

Foreign key display

UPKEYEDI

Update with unique

PRINTOPT

Print option:
Y = to printer
N = to dataset

PRDSNAME

Print dataset name (ignored if PRINTOPT field is Y)

PRDSVOL

Print dataset volser

PRPSW

Print dataset password

PRLSPAG

Print lines per page.

FDB2VERS

Version of File-AID for Db2

SHOWSQL

Type of logging in effect

NONDISP

Character used to represent
non-displayable characters

MAXROWS

A numeric value or an asterisk (*) to denote the number of rows to be selected.

HEXOPT

Hex print option in Row mode.
= Never.
= Always.
= If non-displayable.

FDBCID

File-AID for Db2 Unicode to EBCDIC conversion target CCSID (5 digits).
The value comes from ISPF Terminal CCSID system variable, when this Batch JCL is generated.

 

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