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.

File-AID/RDX record layout file

During the record layout generation process, File-AID/RDX writes to the record layout file.

The record layout file has the following characteristics:

File organization

Partitioned (DSORG=PO) or sequential (DSORG=PS)

Record format

Fixed-blocked (RECFM=FB)

Logical record length

80

If you specify a new file (DISP=NEW), the file organization can be sequential or partitioned.

The record layout file includes the layout for all extracted objects, either in COBOL, PL/I, or FA COBOL format.

Important

When you ask File-AID/RDX to create only a record layout (Create XREF = NO) for MVS objects, the resulting layout is only for the complete extracted record, not the fields within the record (see layout for object FARDX.SAMP.OBJA.KSDS shown in Sample XREF for Db2 and MVS objects.

When the record layout is requested together with an XREF for the extract file, record layouts are only created for all Db2 objects. For MVS objects, the XREF points to the source layout, the one used when the relationship was defined. The XREF assumes that it is the layout file specified with the Create Record Layout function (see MVS File Create Record — E). Also, the generated record layout includes a default layout for all non-data records (see Sample PL/I Record Layout (created with XREF=YES) and Sample XREF for Db2 and MVS objects).

Sample COBOL Record Layout

The following figure shows a sample COBOL record layout. It identifies each object by its name and lists null indicators and column/field names with column/field type and length. When you requested to only create a record layout (Create XREF=NO), the layout includes the extract record ID (Dnnn).

Sample COBOL Record Layout (Create XREF=NO)

****************************************************************
* COBOL RECORD LAYOUT FOR  FRSAMP ORDER_TABLE                    *
******************************************************************
 01  FRSAMP-ORDER-TABLE.                                          
     05 RECORD-ID-D002                PIC X(4).
     05 NULL-INDICATORS.                                          
        10 ORD-STAT                   PIC S9(4) COMP.            
        10 ORD-AMOUNT                 PIC S9(4) COMP.           
        10 ORD-DEPOSIT                PIC S9(4) COMP.             
        10 SHIP-CODE                  PIC S9(4) COMP.           
        10 SHIP-DATE                  PIC S9(4) COMP.             
        10 ORD-DESCRIPTION            PIC S9(4) COMP.            
     05 COBOL-ORDER-TABLE.                                     
        10 ORDER-NUMBER               PIC X(6).                   
        10 CUST-NUM                   PIC X(6).                  
        10 SOC-SEC-NUM                PIC X(11).                  
        10 CREDIT-CARD-NUM            PIC X(16).                  
        10 ORD-TYPE                   PIC X(8).                   
        10 ORD-DATE                   PIC X(10).                 
        10 ORD-STAT                   PIC X(8).                  
        10 ORD-AMOUNT                 PIC S9(7)V9(2) COMP-3.      
        10 ORD-DEPOSIT                PIC S9(7)V9(2) COMP-3.
        10 ORD-LINE-COUNT             PIC S9(9) COMP.
        10 SHIP-CODE                  PIC X(2).      
        10 SHIP-DATE                  PIC X(10).    
        10 ORD-DESCRIPTION.                          
           49 LENGTH                  PIC S9(4) COMP.
           49 TEXT                    PIC X(100).

Sample PL/I Record Layout

The following figure shows a sample PL/I record layout. It identifies each object by its name and lists null indicators and column/field names with column/field type and length. When you requested to create a record layout and XREF (Create XREF=YES), the layout file includes a default layout for all non-data records.

Sample PL/I Record Layout (created with XREF=YES)

/******************************************************************/
/* PLI RECORD LAYOUT FOR TABLE TSOID01 CUSTOMER_TABLE             */
/******************************************************************/
DCL 1 TSOID01_CUSTOMER_TABLE UNALIGNED,
   5 NULL_INDICATORS UNALIGNED,
     10  CONTACT_TITLE_NULL           BIN FIXED(15),
     10  CONTACT_ADDR_NULL            BIN FIXED(15),
     10  CONTACT_CITY_NULL            BIN FIXED(15),
     10  CONTACT_STATE_NULL           BIN FIXED(15),
     10  CONTACT_ZIP_NULL             BIN FIXED(15),
     10  CONTACT_COUNTRY_NULL         BIN FIXED(15),
     10  CONTACT_AREA_CD_NULL         BIN FIXED(15),
     10  CONTACT_TELEPHONE_NULL       BIN FIXED(15),
   5 PLI_CUSTOMER_TABLE UNALIGNED,
     10  CUSTOMER_NUMBER              CHAR(6),
     10  COMPANY_NAME                 CHAR(30),
     10  ADDRESS                      CHAR(30),
     10  CITY                         CHAR(25),
     10  STATE                        CHAR(2),
     10  ZIP_CODE                     CHAR(9),
     10  COUNTRY                      CHAR(20),
     10  AREA_CODE                    CHAR(3),
     10  TELEPHONE_NUM                CHAR(7),
     10  CONTACT_NAME                 CHAR(30),
     10  CONTACT_TITLE                CHAR(30),
     10  CONTACT_ADDR                 CHAR(30),
     10  CONTACT_CITY                 CHAR(25),
     10  CONTACT_STATE                CHAR(2),
     10  CONTACT_ZIP                  CHAR(9),
     10  CONTACT_COUNTRY              CHAR(10),
     10  CONTACT_AREA_CD              CHAR(3),
     10  CONTACT_TELEPHONE            CHAR(7);
 /********************************************************************/
 /* PLI RECORD LAYOUT FOR                                            */
 /*   OBJECT:         NON-DATA-RECORDS                               */
 /*   LAYOUT DSN:     NOT.APPLICABLE                                 */
 /*   LAYOUT MEMBER:  DEFAULT                                        */
 /*   01 LEVEL NAME:  OBJECT_DFLT                                    */
 /********************************************************************/
   DCL 1 OBJECT_DFLT,
          5 RECORD_ID_DFLT_DATA CHAR(27958);

Sample FA COBOL Record Layout

The following figure shows a sample FA COBOL record layout. It identifies each object by its name and lists null indicators and column/field names with column/field type and length. When you requested to only create a record layout (Create XREF=NO), the layout includes the extract record ID (Dnnn).

FA COBOL creates a File-AID COBOL layout with special type VAR for Db2 column type VCHAR or VC, for example when the ORD-DESCRIPTION column is defined to Db2 as VARCHAR(100), with FA COBOL it will be generated as 10 ORD-DESCRIPTION PIC X(100) VAR. Use FA COBOL layout format when you need to define disguise criteria for Db2 tables with column type VCHAR or VC.

Sample FA COBOL Record Layout (Create XREF=NO)

****************************************************************
* COBOL RECORD LAYOUT FOR  FRSAMP ORDER_TABLE                    *
******************************************************************
 01  FRSAMP-ORDER-TABLE.                                          
     05 RECORD-ID-D002                PIC X(4).
     05 NULL-INDICATORS.                                          
        10 ORD-STAT                   PIC S9(4) COMP.             
        10 ORD-AMOUNT                 PIC S9(4) COMP.             
        10 ORD-DEPOSIT                PIC S9(4) COMP.             
        10 SHIP-CODE                  PIC S9(4) COMP.             
        10 SHIP-DATE                  PIC S9(4) COMP.             
        10 ORD-DESCRIPTION            PIC S9(4) COMP.             
     05 COBOL-ORDER-TABLE.                                        
        10 ORDER-NUMBER               PIC X(6).                   
        10 CUST-NUM                   PIC X(6).                   
        10 SOC-SEC-NUM                PIC X(11).                  
        10 CREDIT-CARD-NUM            PIC X(16).                  
        10 ORD-TYPE                   PIC X(8).                   
        10 ORD-DATE                   PIC X(10).                  
        10 ORD-STAT                   PIC X(8).                   
        10 ORD-AMOUNT                 PIC S9(7)V9(2) COMP-3.      
        10 ORD-DEPOSIT                PIC S9(7)V9(2) COMP-3.
        10 ORD-LINE-COUNT             PIC S9(9) COMP.
        10 SHIP-CODE                  PIC X(2).      
        10 SHIP-DATE                  PIC X(10).     
        10 ORD-DESCRIPTION            PIC X(100) VAR.


 

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