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.

Extract Scope panel

The Extract Scope Screen is displayed when you select Option 2 - Extract Scope and Detailed Extract Views from the Extract Menu.

Important

If you are performing a single object extract (where there are no Db2-defined RI or user-defined application relationships in the relationship file that match the driving object), the Extract Navigation Criteria fields are not accessible.

When your profile has navigation criteria Direct set to C or P (see also Direct), a message displays alerting you that the relationship tree for this extract request has been built using the profile’s navigation criteria. The resulting relationship listing may be different than that resulting from navigation criteria Direct Y or N.

Extract Scope Screen

File-AID/RDX ------------------ Extract Scope ---------------------------------
Command ===>                                                    

Driving Object: TSOID01.FRSAMP.ORDERTAB                                         
                                                                               
Extract Navigation Criteria:                                                    
  Direct    ===> Y               ( Y = Yes, N = No)
  Parents   ===> Y                                                              
  Siblings  ===> N                                                              
  Indirect  ===> N                                                              
  Extract scope detail view ===> O   ( O = Object, R = Relationship, N = None)  
Extract Options:                                                                
  Cycle count                                 ===> 1        ( * for no maximum)
  Maximum total rows/records from all objects ===> *        ( * for no maximum)
  Action when maximum count is reached        ===> Q   ( Q = Quiesce, S = Stop)
  Extract from DB2 using Uncommitted Reads    ===> N        ( Y = Yes,  N = No)
  Extract IMPLICITLY HIDDEN columns           ===> N        ( Y = Yes,  N = No)
  Extract from DB2 image copy                 ===> N        ( Y = Yes,  N = No)
  SELECT FROM Temporal Table                  ===> N                      *None*
Scope Summary Counts:                                                           
   3 of   5 Relationships Active
    Related DB2 objects..:   3 of   6 included                              
    Related MVS objects..:   0 of   0 included                                
    Output Key Files.....:   0 of   0 included

Use this screen to specify the way that File-AID/RDX chases the object relationships and what sampling methods it applies during extract processing. This controls the amount of data that can be extracted. Extract Navigation Criteria Examples presents examples for the global extract navigation settings.

You specify how File-AID/RDX should navigate through the related objects with the Navigation Criteria. You can set the navigation and sampling controls globally and then fine tune them individually on an object or relationship basis. Your current profile determines the default settings.

Driving Object

Displays the name of the driving object from which you want to extract related data.

Extract Navigation Criteria

Navigation criteria determines the extend of how File-AID/RDX chases the related objects from the driving object. On this panel, you specify the Navigation Criteria globally, for all included objects and relationships. In the Detail View panels you may then determine the navigation on an individual object or relationship level.

Important

When your profile has navigation criteria Direct set to C or P (see also Direct), all Extract Navigation Criteria fields are protected and cannot be modified during the extract specification. The Description of the Direct field will then also display the respective status, either ** Children only or ** Direct Plus.

To specify the global navigation criteria, specify Yes or No for each of the four navigation switches:

Direct

Extract all of the dependents of the driving object and their dependents.

Any object that is reached by navigating downward from the driving object is a direct descendant so any relationship on this downward navigation has a valid direct descendant path. Only the rows initially selected from the driving object will be sent down this path so the direct descendant path will be navigated only once.

Y

Extract the dependents of the driving object and their dependents (default).

N

Do NOT extract the dependents of the driving object and their dependents.

C

(All Children only) This option can only be set or changed in the profile (see Direct). Extract the dependents of the driving object and all of their dependents only. This option ignores all other Navigational Control Options (DPSI) settings and cannot be modified during the extract specification.

Using the C method to extract data and only its dependent data can lead to extracted data that is not loadable because of referential integrity issues due to the omitted related parent data. This can be useful for extracting specific data that is then used for a purge procedure.

P

(Plus) This option can only be set or changed in the profile (see Direct). Extract all of the direct relationships of the driving object, i.e. all of its parents and first level dependents only. "Plus" means resolve all objects’ parents until there are no more parents to return. This option ignores all other Navigational Control Options (DPSI) settings and cannot be modified during the extract specification.

Important

The C and P settings for Direct can only be set in the profile. The profile settings are used to build the relationship tree with its related objects when starting an extract specification.


Parents

Extract the parents of all extracted data to maintain the integrity of the extracted data.

Any object that is on the upward navigation from a selected object has a valid parent path. This does not mean that every relationship has a valid parent path; navigation has to be possible in an upward direction for the parent path to be valid.

Siblings

Extract other dependents of the extracted parents from the same relationships.

Parent paths are always paired with sibling paths. Whenever a row is sent up the parent path it is possible to come back down the same relationship to get the sibling rows.

Consider a relationship between ORDER and CUSTOMER where a row has been selected from ORDER. The CUSTOMER for that order will be extracted by navigating the parent path. The sibling path would allow all of the rest of the orders for that same customer to be extracted.

Parent/sibling special case:

A many to many application relationship presents a special case where it is possible to have a parent and sibling path defined for a relationship that does not meet the parent criteria specified above. Every many to many relationship has a parent and sibling path.

Indirect

Extract other dependents of the extracted parents from other relationships.

The indirect descendant path includes two different situations. First, it is the downward navigation from any object reached in an upward direction.

Second, it is downward navigation from the driving object and its direct descendants for all rows other than the original selection from the driving object. For an indirect descendant path to be valid on the same relationship as a direct descendant path there has to be a parent path that leads back to the driving object or one of its parents; in effect, another path to the object.

The indirect descendant paths represent downward navigation for objects reached via the parent path. The downward navigation for the relationship that was navigated via the parent path is a sibling path and is not an indirect descendant path. All the other relationships that lead down from an object are valid indirect descendant paths.

This is not to say that a relationship can't have both a sibling path and an indirect descendant path; this is possible when there are multiple parent paths leading to the same object. If the object is on the direct descendant path it is possible to have all three downward navigation paths marked as valid.

Important

The status (Modified) identifies global settings that have been modified individually with the navigation controls of the Relationship Navigation Criteria screen or by the Accept primary or line command of the Check Extract Warning screen.


Extract Scope Detail View

Specify whether you want to view the list of relationships or list of related objects. Set to R or O to view the related objects and their relationships in more detail. In the detail panels, you may apply extract and navigation controls to individual relationships or objects.

N

None does not display either of the detail view panels.

O

Object displays the Extract-Scope-Object-View-panel panel, listing all objects related to the driving object from which to extract data. For more information, see Extract-Scope-Object-View-panel.

R

Relationship displays the Relationship Criteria panel, listing all the relationships associated with the driving object from which to extract data. For more information, see Relationship Criteria.

Important

The Relationship View options are not accessible for a single object extract.

Extract Options

Use these fields to limit the number of records to be extracted in this request. These options also apply to all unrelated objects included in the extract.

Cycle Count

Specify the maximum number of cycles for all relationships leading from the object. Cycle count limits the number of times an object can be visited during an extract. This global setting for the Cycle Count can be modified for each individual relationship (see Cycle).

Maximum Total Rows/Records From All Objects

Specify the maximum number of rows or records to be extracted from all related objects. Once the limit is reached the extract will terminate regardless of how many relationships have been chased. Enter an asterisk (*) to set no limit.

Action When Maximum Count Is Reached

Specify how the extract should terminate when the maximum count has been reached:

Q

Quiesce resolves all orphan records after maximum count has been reached. (May result in more records than the maximum count.)

S

Stop does not resolve possible orphan records. (May extract dependent records without their parents).

Extract from DB2 using Uncommitted Reads

Specify whether File-AID/RDX should extract data from Db2 objects that include Uncommitted Reads or not.

The field is prefilled with the specified UNCOMMITTED_READ_DEFAULT configuration parameter value (Yes or No) of the Db2 Environment PARMLIB member or with the current profile value (Yes or No) if UNCOMMITTED_READ_DEFAULT is set to blank (default, see also UNCOMMITTED_READ_DEFAULT in the Db2 environment).

Extract IMPLICITLY HIDDEN columns

Specify whether File-AID/RDX should extract data from Db2 columns that are defined as IMPLICITLY HIDDEN. When this option is set to Y, the resulting File-AID/RDX extract file will include the data from IMPLICITLY HIDDEN columns.

Extract from Image Copy

Specify whether File-AID/RDX should extract data from Db2 Image Copy data sets or not. This option is only available if your site installation set the product parameter variable UIMGCPY to Yes. For more information, see ALLOW_EXTRACT_FROM_DB2_IMAGE_COPY in File-AID/RDX Product Configuration.

Y

File-AID/RDX extracts related data from the most recent, full Db2 Image Copy for the applicable tablespaces.

For partitioned tablespaces, File-AID/RDX extracts related data from image copy data sets as follows:



      • If the most recent image copy is for the entire tablespace, File-AID/RDX uses the entire data set name.
      • If the most recent image copy is for a partitioned tablespace, File-AID/RDX collects the data set names from the catalog for all other partitions and uses those names.

An image copy data set must exist in the MVS catalog for each Db2 table in the extract request. If not, the extract terminates.

To extract data from a Db2 Image Copy, you must have one of the following authorization privileges:



      • RECOVERDB privilege for the database
      • DBADM, or DBCTRL authority for the database
      • SYSCTRL or SYSADM authority

N

File-AID/RDX will extract from the regular Db2 tables.

Important

The Extract from Image Copy option requires executing File-AID/RDX from an authorized library. Furthermore, the Extract from Image Copy option is not available:

  • For Db2 views.
  • For interactive execution (see also MODE).
  • When extracting from a remote location (see also Location).

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/RDX will display the SELECT FROM Temporal Table screen 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.

If you want to extract data from temporal tables or views without a SELECT FROM Temporal Table statement, make sure *None* displays. To change the status from *Defined* to *None*, enter Yes in the SELECT FROM Temporal Table field, then set the Use System Time and Use Business Time to No in the SELECT FROM Temporal Table screen.

Important

  • When the *Defined* status displays and the extract request includes one or more temporal tables or views, File-AID/RDX will include the SELECT FROM Temporal Table statement even if the SELECT FROM Temporal Table field is set to No.
    The SELECT FROM Temporal Table statement is only generated for each Temporal Table or Temporal View in the extract request.
  • 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.
  • The *Defined* status is saved with the extract request.
  • The SELECT FROM Temporal Table field will be reset to its default (No, *None*) when you exit the extract menu. It will be set to *Defined* when when you return the extract menu with an extract request that includes the *Defined* status.

Scope Summary Counts

The following fields display how many objects and relationships will be included in the extract based on the specified navigation and sampling criteria.

Relationships Active

Displays how many relationships will be used to extract data from the related objects.

Related DB2 objects

Displays how many related Db2 objects will be accessed to extract data from.

Related MVS objects

Displays how many related MVS objects will be accessed to extract data from.

Output Key Files

Displays how many Output Key files File-AID/RDX will create for this extract request.

This section provides information about the following topics:

 

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