This site will undergo a maintenance outage on Saturday, 13 September beginning at 2:30 AM Central/1 PM IST for a platform upgrade. The downtime will be ~three hours.

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.

Excluding an object and object sampling


When the Display scope detail field is set to O on the Extract Scope panel, File-AID/RDX displays the Extract Scope - Object View screen. Your current profile prefills the fields on this panel. Verify that the values match.

This screen displays a list of all the objects in alphabetical order that are related to the driving object based on the relationships defined in the relationship file.

Extract Scope - Object View

 File-AID/RDX -------  Extract Scope - Object View  -------------- Row 1 from 12
 Command ===>                                                  Scroll ===> PAGE

 Primary Commands: EXclude/Unex, Change, Find, Hide, VIew, CHEck, SIze, REPort  
    Line Commands: X = Exclude     A = All        R = Relationship View         
                   U = Unexclude   P = Passthru                                 
 Driving Object: FRSAMP.ORDER_TABLE                                             
           SSID: DSN   Location: DSNLOCAT         Sampling Criteria             
   Object Name                                    Cycle MaxRow Nth Status       
   ---------------------------------------------- ----- ------ --- ----------   
 _ FRSAMP   CONTACT_TABLE                         *     *      *      
 _ FRSAMP   CUSTOMER_TABLE                        *     *      *      
 _ FRSAMP   ORDER_LINE_TABLE                      *     *      2      
 _ FRSAMP   ORDER_TABLE                           *     *      *      
 _ FRSAMP   PART_TABLE                            *     *      *      
 _ FRSAMP   SUPPLIER_TABLE                        *     4      *      
 _ 'TSOID01.FRSAMP.CONTACTT'                      *     *      *      
 X 'TSOID01.FRSAMP.CUSTOMER'                      *     *      *      
 _ 'TSOID01.FRSAMP.ORDERLIN'                      *     *      *      
 _ 'TSOID01.FRSAMP.ORDERTAB'                      *     *      *      
 A 'TSOID01.FRSAMP.PARTTABL'                      *     *      *      
 _ 'TSOID01.FRSAMP.SUPPLIER'                      *     *      *      
 ******************************* Bottom of data ********************************

To exclude a related object from the extract and apply sampling criteria to objects:

In this field…

Do the following:

Nth

Type a 2 in the Nth column for :

FRSAMP ORDER_LINE_TABLE

MaxRow

Type a 4 in the MaxRow column for :

FRSAMP SUPPLIER_TABLE

Line Command

Type an X next to the following object:

'TSOID01.FRSAMP.CUSTOMER'

Line Command

Type an A next to the following object:

'TSOID01.FRSAMP.PARTTABL'

Press Enter

File-AID/RDX redisplays the Extract Scope - Object View screen showing the cascading affect of the EXCLUDE command.

Field Names and Descriptions

This screen displays a list of all related and unrelated objects containing the following columns:.

FIELD

DESCRIPTION

Line Command

Enter line commands in this column. For information about valid commands for this screen, see Line Commands.

Object Name

Displays the name of the related or unrelated object included in the extract request.

Sampling Criteria





Displays the status of the three sampling criteria for each object. You can change each individual setting simply by typing over a new value or use the CHANGE primary command to globally change the sampling criteria fields.

Cycle

The cycle count can be set for each individual object in the extract.

When entered for an object, it limits the number of times an object can be visited during the extract regardless of the number of relationships.

Max Rows

Specify the maximum number of rows to extract via downward navigation (direct, indirect and sibling) of this object. The Max Rows profile value applies to each relationship and each object. The relationship Max Rows values is processed first; if the count does not exceed the limit, the record is passsed on to check against the object Max Rows value.

NTH

(n th record) Specify how many of the eligible records to be extracted should be skipped and not be extract (a value of 3 would extract records 1 and 4).

L

Lock Table; indicates whether or not the Db2 object (table) will be locked during extract. Use the L line command to change the lock status for an individual table.

Important

The L column is only displayed when you have entered the FUNCTION LOCK primary command. The FUNCTION LOCK primary command is only valid if File-AID/RDX was configured at installation to allow locking tables during extract.

Status








Displays one of the following messages:

All

This object will have all of its records extracted, and File-AID/RDX will not chase any of its relationships. This status is the result of the A (All) line command.

Excl Miss

This object is excluded from the current extract process because the object does not exist.

Excl Scope

This object is excluded from the current extract process. This status is the result of a navigation setting or cascading EXCLUDE or ALL command.

Excl User

This object is excluded from the current extract process. This status is the result of the EXCLUDE primary or line command.

Passthru

This object will not have any of its records extracted, but File-AID/RDX will chase all of its relationships. This status is the result of the P (Passthru) line command.

Selected

Indicates that this object has been selected for relationship view with the R (Relationship View) line command.

Unrelated

Indicates that this is an unrelated object that has been added with option 3, Unrelated Objects, for this extract request.

Primary Commands

The following primary commands are available from this screen.

COMMAND

DESCRIPTION

CHANGE (C)

Change allows global changes to be made to the sampling criteria on a column-by-column basis. When the CHANGE command is entered with one of the available parameters CYC=n, MAXROW=n, or NTH=n, all values are changed to the new value n. When entered without parameters, specify the values to change in the “CHANGE Command Window”.

CHECK (CHE)

Check causes the integrity validation processing to be invoked and the resulting error to be displayed.

Important

CHECK is not valid when when the extract n request is built with relationships in the Direct Plus or All Children Only mode (see Direct).

END

Exits the current panel.

EXCLUDE (EX or X)

Enter the EXCLUDE command in the COMMAND field to exclude all relationships in the list displayed on the Relationship Criteria screen from the extract. Use this command in conjunction with the U (Undo) line command or UNEXCLUDE primary command when you have a long list of relationships displayed and you want to include only a few relationships in the extract.

The optional parameters DB2, IMS, and MVS limit the EXCLUDE command to one of the three object types.

FIND (F)

Searches the object list for the specified string and scrolls the list to display the first matching entry at the top of the displayed entries. Use RFind to repeat the search.

FUNCTION LOCK

Enables the “Lock Table during Extract” function for all Db2 objects. The Extract Scope - Object View panel will display and enable the L line command and display the L status column. See also L (Lock Table). FUNCTION LOCK is a toggle switch so enter FUNCTION LOCK again to return to the original format.

Important

The FUNCTION LOCK primary command is only valid if File-AID/RDX was configured at installation to allow locking tables during extract.

HIDE (H)

The HIDE command allows less data to be displayed. Included and excluded objects can be removed or hidden from the display so that the remaining content is more meaningful. Use the RESET command to return all hidden objects to the display.

NAVIGATION (NAV)

The NAVIGATION command takes you directly to the NAVIGATION format of the relationship view.

REPORT (REP)

Prints the logical contents of the display. This report includes all of the displayable lines formatted like the current view.

RESET

Use the RESET command to return all hidden objects to the display.

SAMPLE (SAM)

The SAMPLE command takes you directly to the SAMPLE format of the relationship view.

SIZE (SI)

Increases the scrollable area to display more entries at a time by hiding some of the screen header lines. Size is a toggle switch so enter Size again to return to the original format.

STATUS (STAT)

The STATUS command takes you directly to the STATUS format of the relationship view.

UNEXCLUDE (U)

Enter the UNEXCLUDE command in the COMMAND field to undo a previous EXCLUDE command for all relationships in the list displayed on the Extract Scope - Object View screen from the extract. Use this command in conjunction with the X (exclude) line command or EXCLUDE primary command when you have a long list of relationships displayed and you want to reverse a previous EXCLUDE command to include relationships in the extract again.

VIEW (VI)

The VIEW command allows the user to easily switch between the object and relationship views. SAMPLE, STATUS and NAVIGATION can be used to go directly to the corresponding format of the relationship view. These commands are not included on the primary command line for the object view but will be processed if entered.

Line Commands

The following list identifies the line commands that are available from this screen. For details on each command, see File-AID/Related Data XPERT Reference.

COMMAND

DESCRIPTION

A (All)

Extract all data from this object regardless of the relationships from and to this object and do not chase any relationships associated with this object. The A line command acts as a toggle switch: enter it once to set the status, enter it again to remove it.

Important

The A (All) and P (Passthru) line commands are mutually exclusive. You must remove one before you can set the other.

L (Lock Table)

Indicates whether or not a table will be locked during extract. See also primary commands “LOCK” and “UNLOCK” on page 4-41 that apply to all tables. The L line command is not available if File-AID/RDX was configured at installation to prevent locking tables during extract. In this case, the L column will not be displayed.

Yes
Lock a table while you extract rows from it. This prevents other users from accessing and updating the table until the extract process is complete.

When you specify Yes in the Lock Table field on the Selection Criteria Specification screen, File-AID/RDX issues the following SQL:

LOCK TABLE XXXXXX IN EXCLUSIVE MODEIf you lock a table that resides in a segmented tablespace, only the table is locked. If you lock a table that resides in a partitioned tablespace, all of the partitions are locked. If you lock a table that resides in a simple tablespace, all tables in the tablespace are locked.

No
File-AID/RDX does not issue any lock statements against the table.

P (Passthru)

Don’t extract any data from this object, but process all relationships as if records based on the relationship would have been extracted. The P line command acts as a toggle switch: enter it once to set the status, enter it again to remove it.

Important

The A (All) and P (Passthru) line commands are mutually exclusive. You must remove one before you can set the other.

R (Relationship View)

Mark this object to be included in the Relationship View when the VIEW primary command is entered.

U (Unexclude)

Selects a previously excluded object to be included in the extract. Remember, you cannot undo an excluded object when its link to the driving object is through another, still excluded relationship. See also X (Exclude).

Important

When the excluded status for an object has been set by an extract navigation control, it can only be undone with an extract option, not with the Unexclude line command.

X (Exclude)

Excludes an object from the extract. When you exclude an object, other relationships might also be excluded as a result. This occurs when you exclude an object and either of the objects in the excluded relationship is a parent or dependent in another relationship that cannot be linked back to the driving object in any other way.

 

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