Customizing the document editing interface on VM

The document interface is an IBM-supplied macro for the ISPF/PDF and XEDIT editors. Using this macro, a user operating outside QMF can begin a QMF session. In that session, the user can insert a QMF report into a document while the document is being edited. The report can be created before the editing session begins. More importantly, the user can create the report at the time the GETQMF macro is issued, in a QMF session that the macro started.

Changing the application

Change the application by changing one or more of its components. The components that you can change are members of certain QMF libraries:

Renaming the document interface macro DSQAED2P

The ISPF/PDF macro component DSQAED2P is the macro that users call when they use the document interface. Give the macro a name that has more significance to your users. (Renaming this component has no affect on the other components.) Use the name GETQMF ISREDIT; this is the name used for the macro in this publication. In addition, the following should also be renamed:

You should rename a copy rather than the original. You can place each renamed copy on the production disk where the original resides.

Placing the Q.DSQAED2S procedure in the database

The Q.DSQAED2S procedure is on the production disk. As the user Q, you can place it in the database by entering the following QMF commands:

IMPORT PROC FROM DSQAED2S PROC fm
SAVE PROC AS DSQAED2S (SHARE=YES

where fm is the QMF production disk.

If you are using an NLF: Save DSQAnD2S using the language key identifier for the language you want.

Transferring ownership to Q

If you cannot use QMF as the user Q, you can still issue these commands; however, the procedure is stored in the database under your own authorization ID, rather under Q. To give it the proper name, you must transfer its ownership to Q. You can do this by executing the following commands:

RUN  Q.DSQ0BSQI ( &T=Q.OBJECT_DIRECTORY, &N='DSQAED2S'
RUN  Q.DSQ0BSQI ( &T=Q.OBJECT_DATA, &N='DSQAED2S'
RUN  Q.DSQ0BSQI ( &T=Q.OBJECT_REMARKS, &N='DSQAED2S'

These commands execute an IBM-supplied parameterized query named Q.DSQ0BSQI. Each execution updates one of the QMF control tables. For these executions to be successful, you must have UPDATE authority on the three control tables, or some DB2 for VM authority that implies UPDATE authority.

If, for some reason, you cannot use the query Q.DSQ0BSQI, you can create a copy of it and use the copy instead. The copy would look like this:

 UPDATE Q.&T
  SET OWNER = 'Q'
  WHERE NAME = &N AND OWNER = USER

To delete the object, use the following query:

DELETE FROM Q.&T
WHERE NAME =&N AND OWNER = 'Q'

Changing the data components

There are five data components, all on the QMF distribution library on VM. Unlike the execs and macros, these components contain neither logic nor executable commands. Instead, they contain information that can appear in messages or in the users' reports.

Because the document interface assumes that these components are in a single library, you can modify them in either of the following ways:

The message component

One of the five data components is named DSQAED0L. This component contains messages that can appear on a user's screen while the user is operating the document interface, and keywords for certain QMF commands.

Do not change this component.

If you are using an NLF: The DSQAnD0L component is on the NLF distribution disk and the messages are in the language set in the user's profile.

The DCF components

The DCF (Document Composition Facility) is a licensed IBM text processing system that supports the use of computers in preparing print documentation.

If your installation uses DCF, you might want to change the remaining four DCF components. For more on DCF, see Document Composition Facility: SCRIPT/VS Text Programmer's Guide

A user can tell the document interface that the current document is formatted by DCF. In response, the document interface adds DCF control statements to the user's inserted report. Wherever these statements appear, they consist of all the records in one or another of the DCF components. You can change any or all of the records in a component. The components, and what they supply, are as follows:

DSQABD01

Supplies statements inserted just before the report. In the IBM-supplied component, these are:

.* QMF Document Interface heading control:
.SA
.RH SUP
.RF SUP
.HS 0
.FS 0
.TM 0.5I
.BM 0
.DC CONT OFF
.FO OFF
DSQABD02

Supplies statements inserted just after each page footing. In the IBM-supplied component, the single furnished statement is:

.* QMF Document Interface page footing control:
DSQABD03

Supplies statements inserted just before each page heading. In the IBM-supplied component, these are:

.PA NOSTART
.* QMF Document Interface page heading control:
DSQABD04

Supplies statements inserted just after the end of the report. In the IBM-supplied component, these are:

.* QMF Document Interface footing control:
.RE
.* QMF REPORT END

Changing the execs and macros

As mentioned earlier, these components are all in the QMF production disk. If you change a component, change a copy, not the original, and place it in another library.

The minidisk must be accessed before the QMF production disk. If the document interface is issued from a current ISPF session, then that session needs to have the QMF and ISPF definitions for the ISPF libraries (the ones beginning with ISP) built. This is illustrated in DSQABD2I.

Changing DSQABD2Q

With the document interface, a user operating outside QMF can begin a QMF session. In that session, the user creates the report to be inserted into the current document. DSQABD2Q does the file definitions (FILEDEFs) for this session. Make whatever modifications to the exec you think necessary. For example, you might need to add FILEDEFs for files peculiar to your installation or you might have to change the links and accesses to the QMF, GDDM, and DB2 for VM disks.

Observe that some of these FILEDEFs involve GDDM files. The document interface does not itself use these files, but the user might find this necessary.

If you are using an NLF: Make a separate copy of DSQABD2Q to link to the QMF NLF production disk. Do not rename this exec.

Changing DSQABD2I

Ensure that the link and access to the ISPF/PDF disk is correct.

Changing DSQABD2C

This is the final component to be discussed. It can be modified as shown:

If you are using an NLF: Make a separate copy of DSQABD2C to specify the NLF DCSS name in the ISPSTART and SELECT QMF invocation statements. Do not rename this exec.

[ Previous Page | Next Page | Contents | Index ]