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 Menu panel

After you selected an extract request from either the Extract Reference List or the Request File Member List Screen or whenever you enter the MENU command within the extract option File-AID/RDX displays the Extract Menu as shown in the following figure.

Important

You profile’s selected extract flow (see Panel Customization) might not show the Extract Menu initially. Just issue the MENU command to display it from any of the extract option panels.

The Extract Menu provides a quick overview of your current extract request and its status fields are immediately updated upon return from its sub-options. This allows you to selectively access any of the options or to submit the extract request when all extract criteria are to your liking.

After completing all extract specifications, simply select Option 14 - Submit JCL and File-AID/RDX submits this extract job.

Extract Menu

 File-AID/RDX ------------------  Extract Menu  --------------------------------
 Option ===>                                                   Scroll ===> CSR
                                                          SITE Profile: RDXMENU
 Primary commands: menu-number, ALL, REFerence, REQuest, MODE       SSID: DSN
    Line commands: S or / to create flow through selected options.
              
 Description  ===> DB2-FRSAMP.ORDER_TABLE  

  _  1  Driving Object          DB2-FRSAMP.ORDER_TABLE
  /  2  Extract Scope and       Dep=Y, Par=Y, Sib=N, Ind=N, Cycles=1
        Detailed Extract Views  3 of 5 Relationships Active
  /  3  Unrelated Objects       None
  _  4  Input Key File          None
  /  5  Selection Criteria      None
  _  6  Output Key Files        Attention
  /  7  Extract File            TSOID01.FRSAMP.EXTRACT
  _  8  Data Privacy DISGUISED  DCF: TSOID01.FRSAMP.DISGUISE
  _  9  Supporting Files        Layouts=N, Xref=N, Topaz Visualizer File=N
  _ 10  Checkpoint/Resumption   None
  _ 11  Continue with Load      No
  _ 12  Save Extract Request    Request has not been saved
  _ 13  View JCL                  
  _ 14  Submit JCL 

The top of this screen consists of the following field:

USER Profile or SITE Profile

Displays the name of the current profile that provides the profile settings for this extract request. To change the profile, return to the File-AID/RDX Primary Option Menu.

SSID

Displays the current Db2 subsystem ID you are connected to. Only displays when File-AID/RDX is installed with the Db2 option and the current extract request includes one or more Db2 objects.

Description

Displays a short description for the current extract request. If you are modifying a previous request it is prefilled. When creating a new request, File-AID/RDX fills this description field with the name and object type of the driving object. Using this description is a helpful way to document your extract criteria. To change the description select Option 12- Save Extract Request.

Extract Menu Options

Enter the option number (1 - 11) to select the desired option or enter ALL to step through all options in sequence. Alternatively, you may also select one or more options with the S or / line command.

The Current Values column are display fields only and are updated upon return from each of the extract menu options to reflect the current status and value for the option. A status of Attention is displayed when the option requires further attention, before the extract request can be submitted.

1 - Driving Object

Displays either the Db2 Driving Object or MVS Driving Object panel depending on the driving object’s object type. The MVS panel also includes layout and XREF information.

Current Values shows the full name of driving object for this extract request.

2 - Extract Scope and Detailed Extract Views

Displays the Extract Scope Screen where you specify global navigation and sampling controls. From this screen you access the Extract Scope Detailed View panels where you can specify the navigation and sampling controls for individual objects and relationships from the extract.

Current Values shows the settings of the global navigation and the global Cycles sampling controls. On the second line, Current Values displays how many of the driving object’s relationships are active (included) for the extract, and that an extract from Db2 Image Copy has been requested.

3 - Unrelated Objects

Displays the Unrelated Object Definition panel when unrelated objects have yet to be added for the extract request or the Unrelated Object Specification panel when unrelated objects are already part of the extract request.

Current Values displays None or the number of unrelated Db2 or MVS objects in the request.

4 - Input Key File

Displays the Input Key File Specification panel where you can identify whether the extract uses a key file as selection criteria input for the driving object. The driving object can be a Db2 or MVS object. Input Key File used to be called External Key File in previous releases.

Current Values displays None or the name of the Input Key file.

5 - Selection Criteria

Displays the Object Selection Criteria panel where you can specify selection criteria for any of the objects included in the extract request.

Current Values displays None or Specified (but not) for Driving Object, Delimited, Selective Columns.

Important

Option 10- Checkpoint/Resumption is not available when the extract request includes multiple selection criteria sets (see also 10- Checkpoint/Resumption).


6 - Output Key Files

If the extract request includes relationships to an Output Key File (see IMS and Output Key Files), File-AID/RDX displays the Output Key File Definition panel where you specify the Output Key file for each KEY relationship. If the Output Key files are for IMS data, you can also specify that the BMC Compuware File-AID for IMS extract using the Output Key files is to be executed as a step following the File-AID/RDX extract.

Current Values displays the message “There are no Output Key files defined” or “n of n Key Files” or “n of n Key Files - Execute n IMS Extract”.

7 - Extract File

Specify the output file for your extract request on the Extract File Specification Screen. File-AID/RDX will store all extracted records in this file.

Current Values displays the name of the extract file.

8 - Data Privacy

Select the Data Privacy option in the Data Privacy Specification screen, if you also want the extracted data disguised by applying the disguise criteria rules as defined in the DCF: Disguise Control File or the DPR: Dynamic Privacy Rules Project.

Current Values displays None, the name of the DCF: Disguise Control File, or the DPR: Dynamic Privacy Rules Project.

The DISGUISED indicator is displayed when data in the extract file is to be disguised.

9 - Supporting Files

Optionally, you can request in the Supporting File Specification screen that File-AID/RDX creates a record layout file for all Db2 objects included in the extract, a BMC Compuware File-AID/MVS XREF for the extract file, and/or a Topaz Extract Visualizer file (also known as the File-AID/RDX Extract Mainframe Trace file).

Current Values displays Layouts=n, Xref=n, Topaz Visualizer File=n, where n is either N or Y.

10- Checkpoint/Resumption

Specify whether you want to enable Checkpoint/Resumption for your extract request. With Checkpoint/Resumption enabled you can stop and resume the extract after a specified extract step number, a specified time interval, or a z/OS Operator command. When you select this option, File-AID/RDX presents the Checkpoint-Resumption panel where you identify your checkpoint options and datasets.

Use this functionality when you anticipate a long running extract that might not be completed within your site’s constraints or when you want to tune highly complex extracts.

After you submit an extract request with Checkpoint/Resumption Enabled and the extract completed up to the checkpoint, the extract is ready to be continued. When submitting the extract request again, File-AID/RDX prompts you to continue the extract execution from the checkpoint or cancel the resumption (see also Checkpoint/Resumption Confirmation Windows ).

If you don’t resume the extract, the partial extract file is NOT USABLE as it lacks important trailer records.

Current Values displays None or Checkpoint/Resumption Enabled.

Important

11- Continue with Load

Specify whether the extract request should be a combined extract and load (YES) or just an extract. When you select this option, File-AID/RDX presents the Continue With Load Menu where you identify all your load options and parameters.

Current Values displays Yes or No.

Important


12- Save Extract Request

Specify whether to save this extract request in a file. File-AID/RDX presents the Save Extract Request panel where you identify the extract request file to save your request to. Once you save your extract request it will be added to the Extract Reference List at that time.

Current Values displays Request has not been saved or the name of the extract request file.

Important

Make sure to save the request just before selecting Option 14 - Submit JCL in order to save the request as it will be submitted. If you make changes to the extract request after saving the request, the changes will not be saved in the request file, only in the temporary extract criteria.


13 - View JCL

Select this option to view the JCL for this extract request. File-AID/RDX shows the ISPF/PDF EDIT Screen—File-AID/RDX-generated JCL panel where you review and modify the extract JCL.

Current Values displays the status Unavailable when some required items for the extract request are still missing or incomplete. Revisit some or all extract menu options and provide acceptable extract criteria.

Important

Option 13 - View JCL switches to Option “13 - View REXX” when the MODE primary command has set the execute extract mode to (see Extract Menu - Interactive Extract Mode) INTERACTIVE (online) extract is a configuration option and is only available if specifically installed at your site. For more information, see ALLOW_EXTRACTS_TO_RUN_ONLINE in the Extract, Load and Disguise Options.

14 - Submit JCL

Submits the JCL for this extract request. Watch for the message that the job has been submitted and later for the completion message.

Current Values displays the status Unavailable when some required items for the extract request are still missing or incomplete. Revisit some or all extract menu options and provide acceptable extract criteria.

Important

Option 14 - Submit JCL switches to Option “14 - Execute REXX” when the MODE primary command has set the execute extract mode to INTERACTIVE (see Extract Menu - Interactive Extract Mode). INTERACTIVE (online) extract is a configuration option and is only available if specifically installed at your site. For more information, see ALLOW_EXTRACTS_TO_RUN_ONLINE in the Extract, Load and Disguise Options.

Primary Commands

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

ALL

Selects all available extract menu options for you to step through in sequence. ALL does not include options 11- Continue with Load and 14 - Submit JCL. To submit the extract JCL, select option 14 - Submit JCL separately or enter the SUBMIT command in the View JCL panel.

MODE

Enter the MODE command in the Command field to enable execution of the extract request interactively (online). Extract Menu options 13 - View JCL and 14 - Submit JCL will change to “12 - View REXX” and “13 - Execute REXX” (see Extract Menu - Interactive Extract Mode) to show that the extract will be executed interactively when selecting Option “13 - Execute Rexx”. MODE acts as a toggle switch.

Important

  1. INTERACTIVE (online) extract is a configuration option and is only available if specifically installed at your site. For more information, see ALLOW_EXTRACTS_TO_RUN_ONLINE in the Extract, Load and Disguise Options.

  2. The following options are not available for interactive execution:
    1. Checkpoint-Resumption
    2. Extract from Image Copy
    3. Disguise Extract File
    4.  Output to Topaz Extract Visualizer file (see also Specify Topaz Extract Visualizer File)
  3. If the extract file is a GDS, it must already exist, therefore (0) or (-n) are valid while (+n) is not allowed.

Extract Menu - Interactive Extract Mode

  _  8  Data Privacy            DCF: TSOID01.FRSAMP.DISGUISE
  _  9  Supporting Files        Layouts=N, Xref=N, Topaz Visualizer File=N
  _ 10  Checkpoint/Resumption   None
  _ 11  Continue with Load      No
  _ 12  Save Extract Request    Request has not been saved
  _ 13  View REXX                  
  _ 14  Execute REXX            *** INTERACTIVE EXTRACT MODE ACTIVE *** 

REFERENCE (REF)

Returns to your Extract Reference List to start a new extract request.

REQUEST (REQ)

Returns to a saved extract request file. You also use the REQUEST command to open extract criteria files created with File-AID/RDX prior to Release 3.0. For more information, see Request File Member List.

Important

Make sure to save the request just before selecting Option 12- Save Extract Request in order to save the request as it will be submitted. If you make changes to the extract request after saving the request, the changes will not be saved in the request file, only in the temporary extract criteria.

This section provides information about the following topics:

 

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