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.

Customizing File-AID for IMS/DC

Perform the following tasks to customize the File-AID for IMS/DC:

Task 1 Linkedit File-AID for IMS/DC (XIXDLINK) (optional)

  1. This step is optional unless you elect to use a program name prefix of your own choosing. If so, modify the sample JCL (member XIXDLINK in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

Task 2 make load modules available to DC

Whenever you link or relink the following DC load modules:

IXDEDTF
IXDEDTI
IXDEDTL
IXDEDTS
IXDEDTU
IXDKEY
IXDMAIN
XVJPARM

The new load modules are written to the hlq.SXVJLOAD library.

If you have changed the default programs names, the load modules will be written to the hlq.CXVJLOAD library.

In either case, you must copy these load modules to your IMS.PGMLIB in order to access File-AID for IMS/DC.

Task 3 Generate customized objects

This step provides instructions on what jobs need to be run to generate required and optional customized objects. For more information on security exits, see File-AID-for-IMS-Exits.

Task 3.1 Create Aliases for XIXDMAIN (Optional)

The following JCL member is provided in the File-AID sample library hlq.SXVJSAMP:

  • XIXDALIA - Link Edit to add aliases

Member XIXDALIA creates aliases to the main load module IXDMAIN1.

Important

1: The main program name (default IXDMAIN) is replaced with the value you specified for it in the linkedit JCL XIXDLINK (see Linkedit File-AID for IMS/CICS (XIXCLINK) (Optional) in Customizing-File-AID-for-IMS-CICS).

Important

This task is only required when you install a multiple transaction configuration. If you install a single transaction configuration of File-AID, skip this task.

  1. Modify sample JCL (member XIXDALIA in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

Task 3.2 Assemble and Link IMS Modules (Required)

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

Modify DBD Source Code

  1. Modify the DBD source code for File-AID’s control databases to conform to your installation’s specifications. Each member, IXDLTM, IXDCLT, and IXDAUD, should be updated identically except where noted. The members are found in the Sample Library hlq.SXVJSAMP.

    DBD NAME=IXDLTM,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,30,8177)
    DBD NAME=IXDCLT,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,50,8177)
    DBD NAME=IXDAUD,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,16,250,8117)

    NAME=IXDLTM     (for the LTM database)
    NAME=IXDCLT     (for the CLT database)
    NAME=IXDAUD     (for the AUD database

    If necessary, modify these names to meet your installation’s DBD naming conventions.

    ACCESS=(HDAM,VSAM) (same for all control databases)

    It is recommended that the control databases be organized as VSAM data sets because of their large segment sizes. However, if your installation wants to allocate them as OSAM data sets, change the second parameter to OSAM. Do not change the access method (first parameter).

    RMNAME=(DFSHDC40,1,30,8177)    (for the LTM database)
    RMNAME=(DFSHDC40,1,50,8177)    (for the CLT database)
    RMNAME=(DFSHDC40,16,250,8117)  (for the AUD database)

    Substitute the RBNs calculated in DBD Tailoring for the third parameters. Substitute the RMNAME BYTES calculated earlier for the fourth parameters. The RMNAME BYTES parameter must be the same for the LTM and CLT databases. Do not change the randomizer name (first parameter) or the RAPs per CI (second parameter).

  2. Modify the following:

    DATASET DD1=IXDLTMDD,DEVICE=3380,SIZE=8192  (for the LTM database)
    DATASET DD1=IXDCLTDD,DEVICE=3380,SIZE=8192  (for the CLT database)
    DATASET DD1=IXDAUDDD,DEVICE=3380,SIZE=8192  (for the AUD database)

    DD1=IXDLTMDD    (for the LTM database)
    DD1=IXDCLTDD    (for the CLT database)
    DD1=IXDAUDDD    (for the AUD database)

    If necessary, modify these names to meet your installation’s DDNAME conventions.

    DEVICE=3380 (same for all control databases)

    Change the device to the type used at your installation.

    SIZE=8192 (same for LTM and CLT databases; AUD database can vary)

    Find the row that corresponds to your installation’s Maximum User DB Segment Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat Key Length (for the AUD database) in the tables shown in DBD Tailoring. Substitute the appropriate number from the CI/BLOCK column for the SIZE parameter.

  3. Find the row that corresponds to your installation’s Maximum User DB Segment Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat Key Length (for the AUD database) in the tables shown in DBD Tailoring. Substitute the appropriate number from the Segm Bytes column for the corresponding BYTE operand. Substitute this same number in all the SEGM statements in the appropriate control database DBDs. Each control database DBD must have the same maximum segment size on all its SEGM statements. Do not change the NAME=, PARENT=, PTR=, or the segment minimum size parameters.

    SEGM NAME=GV,PARENT=0,BYTES=(8158,10),PTR=TWIN
    BYTES=(8158,10) (same for all LTM and CLT control database segments)
    BYTES=(8102,48) (same for all AUD control database segments)
    DBD Samples

Generate DBD Control Blocks

In this task, DBD control blocks are generated for the three control databases and the five sample databases.

  1. Submit DBDGENs for the databases using JCL already in place at your installation, or modify the sample JCL (member XIXDDBD in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

Modify PSBs

Modify the PSBs as required by your installation’s configuration. The first six PCBs in the PSB (including the optional Audit Trail PCB) are for File-AID’s use. PCBs 7 through 500 are for your user databases. We recommend that you include the four sample database PCBs in your PSB for the initial installation. Sample Library member IXDMAIN contains these sample databases’ PCBs.

PCB number one is used for message switching between functions. The transaction name in the PCB must be the same as the transaction name that uses this PSB. Change the NAME= operand of the PCB macro accordingly. For more information, see PSB Tailoring.

Important

If the Audit Trail feature is to be activated, you must uncomment the IXDAUD PCB.

Program Specification Block (PSB)

PRINT   NOGEN
PCB TYPE=TP,NAME=FILEAID

PCB TYPE=DB,DBDNAME=IXDCLT,KEYLEN=52,PROCOPT=A,POS=S
SENSEG  NAME=DCLT,PARENT=0

PCB TYPE=DB,DBDNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG  NAME=GV,PARENT=0
SENSEG  NAME=PS,PARENT=GV
SENSEG  NAME=WA,PARENT=GV
SENSEG  NAME=ST,PARENT=GV

PCB TYPE=DB,DBDNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG  NAME=GV,PARENT=0
SENSEG  NAME=PS,PARENT=GV
SENSEG  NAME=WA,PARENT=GV
SENSEG  NAME=ST,PARENT=GV

PCB TYPE=DB,DBNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG  NAME=GV,PARENT=0
SENSEG  NAME=PS,PARENT=GV
SENSEG  NAME=WA,PARENT=GV
SENSEG  NAME=ST,PARENT=GV

PCB TYPE=DB,DBDNAME=IXDAUD,KEYLEN=37,PROCOPT=A,POS=S
SENSEG  NAME=AT,PARENT=0
SENSEG  NAME=ATDEP,PARENT=AT

add user database PCBs here
PCB TYPE=DB,...
 
  .
  .
  .
PSBGEN LANG=PL/I,COMPAT=YES,PSBNAME=IXDMAIN
END

Generate PSB Control Blocks

In this task, PSB control blocks are generated for the PSBs needed for your installation configuration and the PSBs in the source data set members IXDDLET, IXDLOAD, and IXDUPLD.

  1. Submit PSBGENs for these PSBs using JCL already in place at your installation, or modify the sample JCL (member XIXDPSB in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

Generate ACB Control Blocks

In this step, ACB control blocks are generated for the PSBs needed for your installation configuration and the PSB in the source data set member IXDUPLD.

  1. Submit ACBGENs for these PSBs using JCL already in place at your installation, or modify the sample JCL (member XIXDACB in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

Assemble and Link MFS Source Code

Use the JCL already in place or submit member XIXDMFS to assemble and link File-AID’s MFS source code into the IMS format library.

  1. Assemble the MFS source code for the members listed in Make Load Modules Available to DC using JCL already in place at your installation; or modify the sample JCL (member XIXDMFS in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit the job.

A return code equal to or less than 4 is acceptable.

Task 3.3 Allocate LTM, CLT and Audit Trail Data sets (Required)

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

  • XIXDALCO - Allocate Data sets using OSAM
  • XIXDALCV - Allocate Data sets using VSAM

Your installation may choose to allocate the control databases as VSAM or OSAM data sets. Run XIXDALCO if you want the control databases to be OSAM data sets. Run XIXDALCV if you want the control databases to be VSAM data sets.

  1. Modify the sample JCL (member XIXDALCV or XIXDALCO in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
  2. Submit job XIXDALCO or XIXDALCV.

Task 3.4 Security Exit (Optional)

File-AID for IMS/DC provides one exit type to the security exit. Its primary intent is to limit database access and to control whether a user’s database updates are captured by the Audit Trail feature. The default security exit routine provided with File-AID does no processing and returns control immediately to File-AID.

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

  • XIXDSCXD - Compile and Dynamically Link a COBOL Exit
  • XIXDSCXS - Compile and Statically Link a COBOL Exit
  • XIXDSCXA - Compile and Link an ASSEMBLER Exit
  1. Modify the appropriate sample JCL to your site’s requirements by following the instructions in the member.
  2. Submit the job.

You have the following options when installing a security exit:

  1. XIXDSCXD - Compile and Dynamically Link a COBOL Exit
  2. XIXDSCXS - Compile and Statically Link a COBOL Exit
  3. XIXDSCXA - Compile and Link an ASSEMBLER Exit

For more information, see File-AID for IMS/CICS and File-AID for IMS/DC Security Exit .

Task 3.5 Static Link of XVJSFX (Optional to support multiple XVJSFX modules)

The following JCL member are provided in the File-AID sample library hlq.SXVJSAMP:

  • XVJSFXA - Create an XVJSFX load module
  • XIXDSTAT - Statically link XVJSFX
  1. Modify the sample JCL (member XVJSFXA in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member. This will create an XVJSFX load module.
  2. Submit the job.
  3. Modify the sample JCL (member XIXDSTAT in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member. This will statically link XVJSFX.
  4. Submit the job.

Multiple Transaction Configuration

If you want to support transactions that use different configurations of File-AID for IMS/DC within the same IMS region, further steps are required. First, create as many FAIXnnnn PARMLIB members as you require. You will need to create separate versions of the XVJSFX load module for each of them and link them into separate load libraries. Use the XVJSFXA PROC found in the hlq.SXVJSAMP library to create a suffix load module for each of the PARMLIB members you wish to define to the product. Each version must then be statically linked along with the IXDMAIN1 load module into a uniquely named load module for each transaction that is to use that configuration.

Important

1: The main program name (default IXDMAIN) is replaced with the value you specified for it in the linkedit JCL XIXDLINK (see Linkedit File-AID for IMS/DC (XIXDLINK) (Optional)).

When you are done, use the XIXDSTAT PROC found in the hlq.SXVJSAMP library to perform the link edit required to create a load module that has a particular version of XVJSFX linked into it.

Any transaction that is not associated with a load module that does not contain a statically linked version of XVJSFX will use the default 00 suffix version found in the IMS PGMLIB load library, if one exists. The statically linked load module(s) must be made available to IMS.

When maintenance is applied to the XIXDMAIN load module in hlq.SXVJLOAD, you will have to run the XIXDSTAT PROC for each transaction load module that contains a unique version of the XVJSFX module. Remember, the statically linked load module(s) must be made available to IMS.

 

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