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.

Db2 driving object


The following figure is displayed when you enter the NEW command in the Extract Reference List or the Request File Member List screens and your profile specifies that the driving object is a Db2 object, or you enter the Db2 command in the MVS Driving Object screen.

Use this screen to specify a Db2 object to drive the extract.

Db2 Driving Object

 File-AID/RDX -------------  DB2 Driving Object  -------------------------------
 Command ===>                                              

 Primary commands: MVS driving object

 Specify table to drive extract process from:       
   SSID         ===> DSN
   Location     ===>                      (* or pattern for selection list)
   Creator      ===> FRSAMP               (* or pattern for selection list)
   Table Name   ===> *                    (* or pattern for selection list)

 Relationship Information:
   File name or pattern ===> 'TSOID01.FRSAMP.RELATION'                   

   NOTE: For single object extract leave relationship file blank

                             ENTER to continue

After entering the information for the new Db2 driving object, press ENTER to proceed to the Extract Menu.

The body of this screen consists of the following fields:

Specify Table To Drive Extract Process Area

Use the fields in this area to specify the Db2 table for which you want to retrieve relationship information from the relationship file so you can extract related data. When specifying patterns in the fields, File-AID/RDX searches the relationship file and presents selection lists.

SSID

Displays the current Db2 subsystem ID. Type over this field to connect to a new Db2 subsystem. If you leave the Location field blank, the table you specify to drive the extract must exist in the Db2 subsystem displayed here.

Location

Specify the location of the table you want to drive the extract if it resides in a remote Db2 subsystem. The location you enter must be defined in the Db2 system catalog table, SYSIBM.LOCATIONS.

Leave this field blank if the table you want to drive the extract is in the Db2 subsystem in the SSID field.

Important

The Extract from Image Copy option is not available when extracting from a remote location (see also Extract from Image Copy).

Creator

Specify the authorization ID of the owner of the table, view, synonym, or alias that you want to drive the extract process. You can enter a pattern in this field. Valid pattern characters are %, _, and * (see Pattern Characters). If you specify a pattern, File-AID/RDX searches the Db2 catalog and displays matches in a Table List pop-up window.

Table Name

Specify the name of the table, view, alias, or synonym that you want to drive the extract process. For more information about how File-AID/RDX supports views, aliases, and synonyms in Extract, see Use of Db2 Views and Use of Aliases and Synonyms.

You can enter a pattern in this field. Valid pattern characters are %, _, and * (see Pattern Characters). If you specify a pattern, File-AID/RDX searches the Db2 catalog and displays matches in a Table List pop-up window.

Relationship Information:

File name or pattern

Specify the name of the file that contains the referential integrity and application relationship information you want to use for the extract process. To view a list of files, specify a pattern. Valid pattern character is * (see Pattern Characters). If you specify a pattern, select a file from the “Catalog Utility File List”.

Important

If you leave this field blank, File-AID/RDX will perform a single table extract. Optionally, a single table extract now allows to extract selected Db2 columns and/or output of the extract file in delimited format. See Selective Column / Delimited Prompt.

Primary Command

The following File-AID/RDX-specific primary command is valid on this screen:

MVS (M)

Switches to the MVS Driving Object panel prefilled with the applicable information from your profile. See MVS Driving Object.

Use of Db2 Views

File-AID/RDX supports views of Db2 tables in the Extract function. If you specify a view as the driving table, File-AID/RDX lists relationships defined for the view, not the underlying base table. File-AID/RDX then extracts data from the view specified as the driving table/view and from all tables and views related to the driving table/view.

Important

  • Extracting from complex views may create unloadable data. Specifying the base table(s) is recommended.
  • The Extract from Image Copy option is not available for views.

Use of Aliases and Synonyms

File-AID/RDX supports aliases and synonyms of tables in the Extract function. If you specify an alias or synonym as a driving table, File-AID/RDX lists relationships associated with the base table and extracts from the base tables.

Relationship Listing Window for Db2 Objects

When you are creating a NEW extract request, File-AID/RDX searches the relationship file for relationship definitions that match the Object Name name you specified as the driving object. For Db2 objects, if the exact match cannot be found in the relationship file, File-AID/RDX searches for other existing relationship definitions that could be applied for the extract. File-AID/RDX only uses the Table name portion of driving object in searching for relationship definitions. If one or more relationship definitions match the specified Table Name, File-AID/RDX displays the Relationship Listing window.

In the case of Db2 objects, the Relationship Listing window provides a list of objects that have relationships defined in the File-AID/RDX relationship file. You can use the relationship definitions from any given set of objects to extract data from another set of objects that contain the same kind of data. When you select a relationship with a creator other than the creator specified for the driving table, the relationships defined for the driving table may differ from those of the selected table. If File-AID/RDX’s relationship validation routine cannot detect the proper relations in the Relationship file it will issue a warning (see Check Extract Warning).

For example, you could use relationship definitions for the production subsystem to extract data from a similarly related set of tables that reside on the acceptance subsystem as long as no relationships have been defined for the driving table on the acceptance subsystem. Use this screen to select the table for which there exists a relationship definition that you want to use to extract data from a set of tables.

Important

If File-AID/RDX finds a single table that matches both the table name and creator, it bypasses the Relationship Listing window.

Relationship Listing Window—Multiple Relationship Definitions

image2021-10-22_19-16-4.png

If there are more valid relationships than will fit in this window, you can scroll the list of relationships up and down using standard scrolling commands. For more information, see Scrolling.

The screen heading lines contain screen title, row indicator, COMMAND field, and scroll amount input field.

The body of this scrollable window consists of the following fields:

CMD

Enter the S line command in this field to select the relationship definition to use in the Extract process. The S line command selects the relationship definition of the selected object for the driving object.

Object

Displays a list of objects that have relationship definitions in the relationship file that match the value you specified in the Table Name field on the Driving Object - Db2 screen.

The creator of the table you specified to drive the extract is part of this list when RI and/or application relationships have been defined for it in the relationship file.

SSID

Displays the subsystem ID of each table on the list.

No Relationships Exist

If File-AID/RDX does not find any tables that match the specified driving table, it displays a message in the Relationship Listing window that indicates no relationships are defined in the relationship file for the driving table. Press Enter to continue with a single table extract. Or, enter the END command and specify a different relationship file, or different driving object. Or use Option 1, Relationships, to load referential integrity relationships from the Db2 catalog or to generate AR relationships, respectively.

Partially Matching Relationship Panel for Db2 Objects

If File-AID/RDX only finds a single partially matching relationship, it displays the Partially Matching Relationship panel where it displays the information for the specified driving table next to the partially matched information in the relationship file.

Partially Matching Relationship

 File-AID/RDX --------- Partially Matching Relationship -----------------------
 Command ===>                                                  Scroll ===> CSR  
                                                                               
 A single partial matching relationship was found:                              
                Entered                  Match                               
  SSID        : D801                     D801                                
  Location    : D801CW01                 D801CW01                            
  Creator     : FARDX                    FRSAMP                              
  Table Name  : ORDER_TABLE              ORDER_TABLE                         
                                                                               
   Do you wish to continue with: _  
   1 - Single table extract       
   2 - Partially matching relationship)   
                                                                               
 Press ENTER to continue                                                        
 Enter END to terminate processing                                              
                                    

The body of this scrollable window consists of the following fields:

SSID

Entered: Displays the subsystem ID of the specified driving table.

Match: Displays the subsystem ID of the matching table in the relationship file.

Location

Entered: Displays the remote location ID of the specified driving table.

Match: Displays the remote location ID of the matching table in the relationship file.

Creator

Entered: Displays the creator ID of the specified driving table.

Match: Displays the creator ID of the matching table in the relationship file.

Table

Entered: Displays the table name of the specified driving table.

Match: Displays the table name of the matching table in the relationship file.

Do you wish to continue with

Enter either 1 or 2.

1: Single table extract. The resulting extract will NOT extract any related data. This option displays the Selective Column / Delimited Prompt to enable Selective Column extract and output of the extract file as delimited.

2: Partially matching relationship. The resulting extract will extract any related data as defined for the matching table in the relationship file. Any related objects that are missing will be excluded from the extract.

Press Enter to continue with the extract.

Or, enter the END command and specify a different relationship file, or different driving object. Or use Option 1, Relationships, to load referential integrity relationships from the Db2 catalog or to generate AR relationships, respectively.

Selective Column / Delimited Prompt

When File-AID/RDX determines that you have chosen a single table extract, it displays the Selective Column / Delimited Prompt to enable Selective Column extract and output of the extract file as delimited.

Selective Column / Delimited Prompt

 image2021-10-22_19-17-36.png

Only single table DB2 extracts are eligible for a Selective Column extract or delimited extract file.

Selective Column / Delimited Extract

Enter Y to enable Selective Column extract and/or output of the extract file as delimited.

Selective Column Extract

Selective Column Extract allows you to specify the columns of an Object you want to extract. You can indicate the order of the columns and in addition, you can indicate the order that you would like to see the rows extracted. Selection criteria can also be entered for each column. A standard extract data set is created which can be used to load data.

Delimited Extract

Delimited Extract creates an extract data set which may be loadable into other RDBMS or spreadsheets that accept delimited file format. Selective Columns are allowed with the Delimited format. A Delimited Extract file is not loadable in File-AID/RDX.

Enter N to continue with a standard extract without Selective Column or Delimited Extract options.

Delimited Format Options

The Delimited Format Options screen displays once you specified Y to the Selective Column / Delimited Prompt. This screen shows the current options for the delimited extract file format. Use it to modify the options as needed to later download the extracted data. The modified options are saved only for your current session. The following figure shows a sample screen with prefilled options (not the defaults).

Delimited Format Options Screen

File-AID/RDX ---------------------- FRSAMP.ORDER_TABLE              SSID: DSN
COMMAND  ===>

Dataset Format                   ===> 1     (1 = Standard extract file)  
                                            (2 = Delimited, not loadable)
Specify Delimited Format Options:
   Quotation Marks               ===> 2             (1 = Single, 2 = Double)
   Column Delimiter              ===> ,
   Use Quotes on Character Data  ===> YES           (Yes or No)
   Use Quotes on Numeric Data    ===> NO            (Yes or No)
   Extract Column Names          ===> NO            (Yes or No)
   Date Format                   ===> YYYY-MM-DD    (Specify desired mask)

Dataset format

Specify whether the data should be extracted in standard Db2 or delimited file format. You must enter either a 1 or 2, or you receive the error message “Invalid value”.

Enter a 1 for standard file format.

Enter a 2 for delimited file format.

Important

Extracted data in delimited file format cannot be loaded using File-AID/RDX’s Load utility (see also chapter Load).

Specify Delimited Format Options

Quotation Marks

Specify which quotation marks, single (’) or double (“) should be used in the delimited file format. Double quotation marks are the initial default.

Enter a 1 for single quotation mark.

Enter a 2 for double quotation mark.

Column Delimiter

Specify which character should be used as the column delimiter. The column delimiter marks the end of the previous and the beginning of the next column. Any displayable character, including blank character, is acceptable. Comma (,) is the initial default.

Use Quotes on Character Data

Specify whether character data will be enclosed by quotation marks. When set to YES (initial default), the output looks like “JONES”,”MARY”. Numbers containing special characters, for example date fields, are considered character data. For example, if set to YES the date field could look like this “1995-09-29”. When set to NO output would look like this: JONES,MARY or 1995-09-29.

Important

VARCHAR columns are expanded to their maximum length and padded with blanks.

Use Quotes on Numeric Data

Specify whether numeric data will be enclosed by quotation marks. When set to YES, the output looks like “12345”,”6789”. There should not be any decimal points specified for fixed or floating point decimal columns. When set to NO, the output looks like 12345,6789. NO is the initial default.

Extract Column Names

Specify whether column names will be included as the first row in the extract file. Column names follow the same format as for Character data. An example is “EMPLOYEE_ID”,”LASTNAME”,”FIRSTNAME” etc. If YES, the extract file includes all selected column names. The initial setting is NO.

Date Format

Specify the format to mask date data. Any valid date format is acceptable, for example YYYY/MM/DD, DD.MM.YYYY, or MM/DD/YY. The initial date format is the same as the installation default for date format.

Press END (PF3) to continue to the Object Selection Criteria - Selective Columns screen.

Object Selection Criteria

The following figure is displayed after you pressed END (PF3) complete the Extract Options screen (Delimited Format Options Screen). The screen is used to identify the columns to be extracted, indicate the order of extraction, and to provide selection criteria for extraction of specific rows of data.

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

Important

You achieve “Full Table Extract” by NOT selecting any columns in the SEL column.

If triggers exist on the extract table, the message ‘Triggers not activated’ displays in the upper right-hand corner of the Object Selection Criteria screen.

Object Selection Criteria - Selective Columns

 File-AID/RDX ---------------  Object Selection Criteria  ----------------------
 Command ===>                                                   SCROLL ===> CSR
                                                                               
 Specify selective column and selection criteria for table FRSAMP.ORDER_TABLE   
                                                                               
                                                                               
  SEL    Column Name           Type(Length) Order (A/D)  Where         More: >  
  ---  - --------------------  ------------ ----- -----  ----+---10----+---20--
  ___  P ORDER_NUMBER          CHAR(6)       ___                                
  ___    CUST_NUM              CHAR(6)       ___                                
  ___    SOC_SEC_NUM           CHAR(11)      ___                                
  ___    CREDIT_CARD_NUM       CHAR(16)      ___                                
  ___    ORD_TYPE              CHAR(8)       ___                                
  ___    ORD_DATE              DATE          ___                                
  ___    ORD_STAT              CHAR(8)       ___                                
  ___    ORD_AMOUNT            DEC(9,2)      ___                                
  ___    ORD_DEPOSIT           DEC(9,2)      ___                                
  ___    ORD_LINE_COUNT        INTEGER       ___                                
  ___    SHIP_CODE             CHAR(2)       ___                                
  ___    SHIP_DATE             DATE          ___                               
  ___    ORD_DESCRIPTION       VCHAR(100)    ___                                
         ** End of Columns ** 

SEL

Place an S next to the column(s) from which you want data extracted. Unselected columns will not be included in the extract file.

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

Displays the names of the columns in the table, view, or alias.

TYPE(LEN)

Displays the type and length of data in each column.

Distinct types are identified by their names.

Important

Columns with type LOB or DISTINCT based on LOB cannot be extracted to an extract file in delimited format.

ORDER

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

A/D

Indicate whether ordered columns are to be sorted in ascending (A) or descending (D) order. If neither is specified, A is the default.

WHERE

Enter WHERE clauses to limit row selection. 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.

The following delimiters can be used in the clauses:

>

OR

< >

<

> =

BETWEEN

=

< =

IN

¬ =

¬ >

LIKE

AND

¬ <

NOT

Important

Special considerations for DISTINCT (UDT) data type columns: File-AID/RDX 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.

Press END (PF3) to continue.

Related topics

 

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