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.

View JCL


The ISPF/PDF Edit screen shown in the following figure is displayed when you select Option 13 - View JCL, from the Extract Menu.

ISPF/PDF EDIT Screen—File-AID/RDX-generated JCL

 EDIT - File-AID/RDX Generated JCL                             COLUMNS 001 072
 Command ===>                                                  SCROLL ===> CSR
     You are now viewing the JCL that File-AID/RDX has generated to perform
     the required function. Change this JCL as desired before submitting.  

 ****** ***************************** TOP OF DATA ******************************
 000001 //TSOID01 JOB ('XXXXXXX.0XXX'),
 000002 //     'INSTALL FR 21.1',
 000003 //     MSGCLASS=X,NOTIFY=TSOID01,CLASS=A
 000004 //*                                                             XFRJXTRT
 000005 //EXDRV   EXEC PGM=XFREXEC,REGION=8192K,MEMLIMIT=4G,
 000006 //        PARM=(FR,2,B)
 000007 //STEPLIB  DD DISP=SHR,DSN=CPWR.MXVJ170.CXVJLOAD
 000008 //         DD DISP=SHR,DSN=CPWR.MXVJ170.SXVJLOAD
 000009 //         DD DSN=DSNA10.SDSNEXIT,DISP=SHR
 000010 //         DD DSN=DSNA10.SDSNLOAD,DISP=SHR
 000011 //RDXMLIB  DD DSN=CPWR.MXVJ170.SXVJMENU,DISP=SHR
 000012 //RDXEC     DD DSN=TSOID01.RDX.EXTCRIT.D130314.T155100,
 000013 //          DISP=SHR
 000014 //EXTRACT  DD DSN=TSOID01.FDSAMP.EXTRPDS(CUSTOMER),    
 000015 //            DISP=OLD                                
 000016 //EXTPARMS DD DSN=TSOID01.RDX.PARMS.D130314.T155100,   
 000017 //            DISP=SHR                                 
 000018 //* 

Use this screen to view or edit the extract JCL generated by File-AID/RDX. Use the SUBMIT command to submit the extract request for execution. If you want to save this JCL, use the ISPF/PDF CREATE or REPLACE command before you exit the panel. If you did not save the extract request with Option 12- Save Extract Request, File-AID/RDX deletes the temporary extract criteria work file after extract execution.

Important

  • If your extract request includes disguising the extracted data, see also Set Incomplete Disguise Continuation Indicator to determine whether you want to change the default disguise EXEC parameter.
  • You receive the informational message “I321 RDX CNTL PDSE's not deleted, ISPF SUBMIT or CREATE command issued during VIEW of JCL” to remind you that some extract work files were not deleted and to clean up the extract work files when you don’t need them any longer.
  • When disguising the extract with BMC Compuware File-AID Data Privacy defined Dynamic Privacy Rules (DPR), specify a region size large enough to run Java (REGION=0M is suggested, 200M is the minimum) in your jobcard. See also Disguise Extract File, option 2, Use DPR.
  • The FARULES DD identifies the Privacy Rules Repository name and Dynamic Privacy Rules Project ID.
  • The FARULES DD may be allocated to a sequential file or a member of a PDS. The record length must be fixed 80 bytes.

XVJPRINT Execution Log Output

BMC Compuware File-AID Data Privacy jobs now write execution information to XVJPRINT DD (instead of SYSPRINT DD). If XVJPRINT DD does not exist in your JCL, File-AID will dynamically allocate XVJPRINT.

If you want the execution log output sent to a file, point XVJPRINT DD at a file (instead of SYSOUT=*). This file must be allocated with RECFM=FBA, LRECL=133.

Optional Data Privacy Report Output Written to a File

If you want the Data Privacy Report information written to a fixed layout sequential file and/or to a CSV (Comma Separated Values) file, manually add the appropriate DD statement to the BMC Compuware File-AID Data Privacy job.

Important

  • When disguising multiple objects, the disposition of the file pointed at by DPRSTAT1 or DPRSTAT2 must be "MOD". If it is "OLD", only the columns of the last object will be found in the file.
  • This functionality requires BMC Compuware File-AID Data Privacy Release 17.2.3 or newer.

DPRSTAT1 DD (Fixed Layout Sequential File)

When you add a DPRSTAT1 DD to a BMC Compuware File-AID Data Privacy job and it points at a file defined as RECFM=FB,LRECL=2737, at end of job, the file will have the report information for each column written out as a single record containing all the same report information but in a formatted fixed layout sequential file.

Example:

//DPRSTAT1  DD  DSN=fixed_layout_sequential_file,
//              DISP=MOD

or for a new file:

//DPRSTAT1  DD  DSN=fixed_layout_sequential_file,
//              DCB=(RECFM=FB,LRECL=2737,DSORG=PS),
//              SPACE=(TRK,(1,2),RLSE),                            
//              UNIT=SYSDA,    
//              DISP=(NEW,CATLG,CATLG) 

Record Layout for Output File

To view the output file in formatted mode you can use BMC Compuware File-AID/MVS Browse or Edit with the following COBOL record layout describing a record in the output file:

01  DPR-STATISTICS.                                      
    15  DPR-COLUMN-NUMBER                  PIC 9(9) COMP.
    15  DPR-NUMBER-CHANGED                 PIC 9(9) COMP.
    15  DPR-NUMBER-INVALID                 PIC 9(9) COMP.
    15  DPR-COLUMN-NAME                    PIC X(128).   
    15  DPR-RULE-NAME                      PIC X(512).   
    15  DPR-RULE-DESCRIPTION               PIC X(512).   
    15  DPR-LAYOUT                         PIC X(1573). 

DPRSTAT2 DD (CSV)

When you add a DPRSTAT2 DD to a BMC Compuware File-AID Data Privacy job and it points at a CSV (Comma Separated Values) file defined as RECFM=VB,LRECL=2751, at end of job, the file will have the report information for each column written out as a single record containing all the same report information but they will be Comma Separated Value (CSV) records.

Example:

//DPRSTAT2  DD  DSN=CSV_file,
//              DISP=MOD

or for a new file:

//DPRSTAT2  DD  DSN=CSV_file,
//              DCB=(RECFM=VB,LRECL=2751,DSORG=PS),
//              SPACE=(TRK,(1,2),RLSE),                            
//              UNIT=SYSDA,    
//              DISP=(NEW,CATLG,CATLG) 

Optional Source Data Identifiers (SDIs) Override During Execution

File-AID/RDX now allows you to replace, during execution of a DPR project, Source Data Identifiers (SDIs) defined in the BMC Compuware File-AID Data Privacy project.

To override SDIs, manually add the following DD statement to the JCL:

//DPRSDI   DD   DISP=SHR,DSN=u.data.mysdis

where the existing data set u.data.mysdis contains the definitions of SDIs that will be used for this execution.

If the DPRSDI DD is defined in JCL, all SDIs defined in the project will be ignored and replaced with definitions provided in the override data set.

If the specified override file does not exist, Message UNABLE TO OPEN DPRSDI FILE is issued and processing stops with a RC=8.


Override File Format

Replacement SDIs can be defined either in XML or in JSON format. The tags in XML and names in name/value pairs in JSON correspond to SDI properties that can be defined through the Compuware Workbench User Interface. Refer to the Source Data Identifier Overrides topic in the Compuware Workbench File-AID Data Privacy User Guide for more information.

Override Data Privacy Environment Parameters

If you need to, you can override the Data Privacy Environment parameters listed in the following table (established with your site’s File-AID Data Privacy Environment parameters. For more information, see File-AID Data Privacy Environment.

Data Privacy Environment Parameter Overrides

Parameter

DD statement

JAVA_VIRTUAL_MACHINE_PATH 
(z/OS UNIX Path Name for Java Virtual Machine (JVM))

FAJPATH

JAVAOPNn
(Java (JVM) Options)

FAJOPTS

FILEAID_SERVICES_USER_EXECUTION_PORT
(File-AID Data Privacy IP address and execution port)

FAIPADDR

FILEAID_RULES_ENGINE_PATH
(z/OS UNIX Path Name for File-AID Rules Engine (FARE), formerly Common Disguise Engine (CDE))

FAEXPATH

To do so, insert any of these FAJPATH, FAJOPTS, FAIPADDR, and FAEXPATH DD statements as needed. For example:

//FAIPADDR  DD  *
127.372.322.101
:4180
/*
//FAJPATH  DD  *
/usr/lpp/java/J7.1_64.bld111513/
/

It is also possible to specify more than one debug parameter inline. For example:

//FADEBUG  DD  
Level=FINER         
Filename=/u/userid/
/*

Override Execution Parameter in a Data Privacy Project

In order to override an execution parameter (public variable or translate table) in a Data Privacy Project, add a DPRPARMS DD statement to your JCL. This DD can point to a file or a PDS member containing the override values (maximum record length is 512 bytes). The override values can also be specified inline. Specify override values in the following way:

executionParm=overrideValue

The execution parameter must have been defined in the BMC Compuware Topaz Workbench user interface for the project.

Example:

Your DPR project ‘project1’ includes:

  • 2 translate tables, ‘Title table’ and ‘Titles for HR dept’ (Manage Translate Tables
    • The source table for ‘Title table’ is file ‘ABC.TRANS’.
  • 2 public variables, ‘scramvar’ and ‘altscram‘ (Process Variables
    • The initial value for ‘scramvar’ is string ‘123abc’.
  • 2 execution parameters, ‘Parameter1’ identifies the translate table ‘Title table’ and ‘Param2Variable’ identifies variable ‘scramvar’ (Manage Execution Parameters).

At execution time, however, you want to override the defined execution parameters for translate table ‘Title table’ with the new translate table ‘ABC.NEWTRANS’ and the initial value of variable ‘altscram‘ with the new string ‘789xyz’. The new translate table must have the same characteristics as the original one.

To do so, insert the following DPRPARMS DD statement in the JCL (inline example):

//DPRPARMS  DD  *
Parameter1=ABC.NEWTRANS
Param2Variable=789xyz
/* 


Manage Translate Tables

image2021-10-25_10-37-0.png

Process Variables

image2021-10-25_10-37-28.png

Manage Execution Parameters

image2021-10-25_10-38-0.png

Execution Parameter List of Values

If the execution parameter variable type is either a String List or Numeric List, you can also override the list of values.

Specify a list of values in the following way:

executionParm=LIST(X)=overrideValueXoverrideValueXoverrideValue

The X variable inside the =LIST( )= parentheses defines the delimiter for the list of values. The delimiter can be any character. Connect each overridevalue with the defined delimiter.

For example, insert the following DPRPARMS DD statement in the JCL (inline example) to override the values of the String List named STATE (* is the defined delimiter):

//DPRPARMS  DD  *
STATE=LIST(*)=MI*OH*RI*CA*MO*IN
/*

Multiple Origins for a Data Privacy Rule

Normally, when a Data Privacy Rule is applied to a related field, one object1 in the relationship thread is chosen as the “origin”. For every record in the origin, the Data Privacy Rule is applied to the related field and the BEFORE and AFTER values are saved. For every record in a “non-origin”, the Data Privacy Rule is not applied. Rather, the appropriate AFTER value is retrieved from where it was saved. This guarantees relationship integrity.

This methodology is efficient and sufficient in most scenarios, but there are some scenarios where no single origin contains all of the values required by the non-origins. When this occurs, it is possible to direct File-AID to use all objects that contain the necessary fields referenced by the Data Privacy Rule as origins. This directive is specified by adding to your JCL:

//MULTISRC DD DUMMY

Important

The use of multiple origins degrades job execution performance, so it is not recommended as a default behavior.

Important

1: An object is a Db2 table, an MVS file, or an IMS segment.

Special Instructions for Oracle Translate Table

If your Data Privacy job uses Data Translation with an Oracle Translate Table and your File-AID Data Privacy Environment parameters do not include the following JAVA options (for more information, see File-AID Data Privacy Environment), insert the following FAJOPTS DD statement after the FARULES DD statement:

//FAJOPTS  DD  *
-verbose:sizes
-Dfile.encoding=UTF-8
-Dlog.encoding=IBM1047

If the JAVA options in the File-AID Data Privacy Environment parameters include other site specific JAVA options, also add them to the FAJOPTS DD statement before submitting the job.

Adding the above FAJOPTS DD statement will override the JAVA options in the File-AID Data Privacy Environment parameters and make it possible to run an Oracle translation while the log will be generated in EBCDIC.

An indicator that you need to make this JCL change is when the Data Privacy job ended with the following error:

Method execPrivacyRules failed (RC=8) at line nnn in file EXECDPR.C.

However, this general message is not conclusive. Your error log file should have something like the following:

Throwable occurred: java.sql.SQLException: Internal - Unexpected value              
 at oracle.jdbc.driver.T4CTTIoauthenticate.processRPA(T4CTTIoauthenticate.java:516)
 at oracle.jdbc.driver.T4CTTIfun.receive(T4CTTIfun.java:295)                        
 at oracle.jdbc.driver.T4CTTIfun.doRPC(T4CTTIfun.java:186)                          
 at oracle.jdbc.driver.T4CTTIoauthenticate.doOSESSKEY(T4CTTIoauthenticate.java:390)
 at oracle.jdbc.driver.T4CConnection.logon(T4CConnection.java:356)                  
 at oracle.jdbc.driver.PhysicalConnection.<init>(PhysicalConnection.java:531)       
 at oracle.jdbc.driver.T4CConnection.<init>(T4CConnection.java:221)                 
 at oracle.jdbc.driver.T4CDriverExtension.getConnection(T4CDriverExtension.java:32)
 at oracle.jdbc.driver.OracleDriver.connect(OracleDriver.java:503)                  
 at java.sql.DriverManager.getConnection(DriverManager.java:322)                    
 at java.sql.DriverManager.getConnection(DriverManager.java:358)    

If you see the above, then you need to insert the FAJOPTS DD statement.

Redirect File-AID/Data Solutions Report (Data Disguise with DCF only)

When using a Disguise Control File (DCF) to disguise extracted data, you can choose to redirect the disguise report output produced by BMC Compuware File-AID/Data Solutions to FADSPRNT DD by simply adding it to the JCL in the disguise step. The FADSPRNT DD can point at a file or at SYSOUT. When it points at a file and multiple objects are being disguised, use DISP=MOD.

Since the use of FADSPRNT splits the BMC Compuware File-AID/Data Solutions report output away from the File-AID/RDX report output, FADSPRNT and SYSPRINT must be looked at together to get a complete picture of the job.

Control Card Cleanup

The last step, CLEANEXT, in the extract jobs deletes the File-AID/RDX EXTPARMS parameter file. Whether step CLEANEXT is commented out or executed is determined by the global job option Delete in-stream data data sets at EOJ in Option-G-global-user-defaults. If the job option is set to NO, File-AID/RDX EXTPARMS parameter files created in the extract jobs will NOT be deleted. Keeping the data sets until all steps run successfully allows for the restarting of the JCL at any step.

Periodically, you may want to manually delete the EXTPARMS parameter files that are no longer needed for saved jobs to be resubmitted.

View REXX

The ISPF/PDF Edit screen shown in the following figure is displayed when you select Option 12, from the Extract Menu and the Execute Extract online status has been set to ON with the MODE primary command.

ISPF/PDF EDIT Screen—File-AID/RDX Generated REXX

 VIEW - File-AID/RDX Generated REXX                            COLUMNS 001 072
 Command ===>                                                  SCROLL ===> CSR
     You are now viewiing the REXX that File-AID/RDX has generated to perform
     the required function.  



 ****** ***************************** Top of Data ******************************
 000001 /* REXX */          
 000002 /* TRACE R */        
 000003 MSG_STAT = MSG("OFF")    
 000004 ADDRESS TSO         
 000005 'FREE FI(DFSPARM)'
 000006 'FREE FI(SYSOUT)'  
 000007 'FREE FI(RDXEC) '  
 000008 'FREE FI(RDXMLIB) '
 000009 'FREE FI(EXTRACT) '
 000010 'FREE FI(X37MSG)'  
 000011 'FREE FI(PROGRESS)'
 000012 'FREE FI(REPORT) '
 000013 'FREE FI(RDXSQLCD)'
 000014 'FREE FI(SYSTERM) '
 000015 'FREE FI(SYSPRINT)'
 000016 'FREE FI(TPTPRINT)'

Use this screen to view or edit the extract REXX statements generated by File-AID/RDX. If you want to save these Rexx statements, use the ISPF/PDF CREATE or REPLACE command before exiting this panel. Otherwise, File-AID/RDX deletes this file after extract execution.

 

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