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.

Overview of File-AID for IMS/FLEX


File-AID for IMS/FLEX is a general purpose IMS database manipulation tool for use by business professionals involved in modifying or reporting on the contents of IMS databases. File-AID for IMS/FLEX extends the capabilities of File-AID for IMS to the MVS batch environment.

File-AID for IMS/FLEX simplifies the maintenance of IMS databases by using existing Data Base Descriptions (DBDs); existing or dynamic Program Specification Blocks (PSBs); and COBOL, PL/I, or DL/I segment layouts, without modification, to manipulate databases. Because File-AID for IMS/FLEX is built upon File-AID for IMS, it provides industrial strength editing capabilities while maintaining the system integrity and providing the auditing capability that users have come to expect from the File-AID name.

File-AID for IMS/FLEX is controlled by an easy-to-use and extremely powerful command set. File-AID for IMS/FLEX allows users to quickly and accurately select the data they desire and then allows them to print or modify that data. Users may also output the concatenated keys of the desired segments for later use as input.

PSB Support

Users of File-AID for IMS/FLEX may use either static (pre-existing) PSBs or dynamically built PSBs. Command validation ensures that the requested segments are available and that the process options (PROCOPTS) support the requested commands. File-AID for IMS/FLEX supports segment-level sensitivity for static PSBs.

The P processing option must be specified if updates are performed.

The following IMS options are not supported:

  • A PCB where the processing sequence is a secondary index and the source and target segments are not the same segment type.
  • A PCB that includes segments using field level sensitivity.

Supported IMS Environments

File-AID for IMS/FLEX supports both DL/I batch and IMS BMP (Batch Message Processing) environments. File-AID for IMS/FLEX is invoked using standard MVS JCL and procedures similar to those provided by IMS. The DL/I access methods of HSAM and SHSAM are not supported for the update function.

Segment Level Data Mapping

File-AID for IMS/FLEX users can specify the desired fields with COBOL, PL/I, or DL/I field names. This capability enables the application programmer to select and update database segments based on the fields that are familiar to them. It also allows the data supplied by the user to be validated against the target field definition, which reduces the amount of invalid data. The corresponding COBOL and PL/I copylib members are defined by the File-AID for IMS XREF facility. They:

  • Can be a member of a partitioned dataset or a sequential dataset.
  • Must have an RECFM of F or FB.
  • Must have an LRECL of 80.

File-AID for IMS/FLEX Reports

File-AID for IMS/FLEX provides several reports that detail and summarize the results of the users’ command statements:

  • Command Validation Report: A detailed listing of the command statement and any associated messages.
  • Command Execution Report: A detailed listing of the command statement and the actual command results.

    Segment Print

    Provides formatted segment, formatted field, or unformatted segment output.

    Segment Change

    Provides field-level, formatted output of changed fields.

    Segment Delete

    Provides segment-level, formatted output of the deleted segment.

    Segment Insert

    Provides field-level, formatted output of fields with non-default values.

    Segment Extract

    Provides the function of writing specified fields from selected segments to an output dataset.

  • Command Summary Report: The overall results of the command statement. The results include the number of segments retrieved, selected, counted, printed, changed, deleted, inserted, or extracted.
  • Execution Summary Report: The overall results of the total execution. Results are provided per segment per database PCB. This report is written to both SYSOUT and IXPSTATS.
  • The Command Validation report is suppressed when there are no validation errors detected for TYPE RUN. If the SYSOUT DD statement is changed from a data set to an output class, then the Command Validation report is not suppressed. For TYPE VALIDATE, the Command Validation report is not suppressed.

    Users with large volumes of output can dummy the SYSOUT DD statement and still receive the Execution Summary report and any error messages written to the IXPSTATS DD statement. The DL/I call information and PCB information follow any error message.

Primary Commands

Each of the following File-AID for IMS/FLEX primary commands, as well as object keywords, optional keywords, and values are fully described in Command-statements.

COUNT

Counts segments, extracts concatenated keys of segments, or both.

INSERT

Inserts an occurrence of the specified segment into a database.

PRINT

Prints segments in formatted or unformatted mode or prints fields in formatted mode.

PSB

Specifies the target database name or the PCB of the target database to be processed.

SELECT

Applies segment selection criteria. SELECT is always used with one or more of the following sub-commands: CHANGE, COUNT, DELETE, INSERT and PRINT.

SET

Overrides the system processing options.

SETEXTRACT

Overrides the system processing options of the EXTRACT sub-command.

TITLE

Defines the title of a report.

TYPE

Specifies whether the command statements are to be validated only or validated and immediately processed.

Database Security

File-AID for IMS is compatible with any data security software your installation might have (e.g., CA ACF2, RACF, or CA Top Secret). File-AID for IMS/FLEX processing does not circumvent your security software in any way.

File-AID for IMS/FLEX supports the File-AID for IMS security exits. These exits are called during File-AID for IMS/FLEX processing.

Following are examples of uses of the optional security exit routines:

  • To limit access to certain databases.
  • To override File-AID for IMS/FLEX’s default database allocation status from DISP=OLD to DISP=SHR during database editing if your installation uses IMS data sharing.
  • To force the creation of an audit trail during any user’s File-AID for IMS/FLEX execution through a security exit routine.
  • To enable you to enter a shorthand version of a database dataset name that is then translated to a full data set name.
  • To override or customize the parameters passed to IMS based on the database you are processing.
  • To validate your specification for the automatic creation and deletion of the IMS log data set during database editing.

If you require information about your installation’s security exit routine, contact the person responsible for File-AID for IMS at your installation.

File-AID for IMS/FLEX Audit Trail Feature

File-AID for IMS/FLEX uses the existing File-AID for IMS audit trail facility, which is described in Audit-trail-facility. All update activity during a given execution can be captured in an audit trail dataset. The audit trail facility is invoked by the presence of an IXPAT DD statement in the execution JCL. Every change, delete, or insert performed causes the before and/or after image of the updated segments to be written to the audit trail dataset.

File-AID for IMS/FLEX provides your installation with the ability to force the creation of an audit trail during any user’s execution through a security exit routine. The process is especially useful if your installation wants to ensure that an audit trail is created whenever File-AID for IMS is used to edit certain sensitive databases.

 

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