SysWorks
Application Development Guide

9.7 CDD

Requirements for CDD are summarized in Table 9-12.

Table 9-12 CDD Requirements
File Name Suffix and File Type Feature Sematics

_REC.CDDL, _REC.DDL CDD record source.

define record Record definition. The name must either start with appl_RECORDS. or start with appl and finish with _REC.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-12 CDD Requirements**
File Name Suffix and File Type	Feature	Sematics
_REC.CDDL, _REC.DDL		CDD record source.
	define record	Record definition. The name must either start with appl_RECORDS. or start with appl and finish with _REC.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.8 CDD/Repository

Requirements for CDD/Repository are summarized in Table 9-13.

Table 9-13 CDD/Repository Requirements
File Name Suffix and File Type Feature Sematics

_FLD.CDO CDD/Repository field source.

define field Global field definition. Field names should either start with appl_FIELDS. or not finish with _REC.

_REC.CDO CDD/Repository record source.

define field Local field definition. Same rules apply as for global fields.

define record Record definition. The name must either start with appl_RECORDS. or start with appl and finish with _REC.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-13 CDD/Repository Requirements**
File Name Suffix and File Type	Feature	Sematics
_FLD.CDO		CDD/Repository field source.
	define field	Global field definition. Field names should either start with appl_FIELDS. or not finish with _REC.
_REC.CDO		CDD/Repository record source.
	define field	Local field definition. Same rules apply as for global fields.
	define record	Record definition. The name must either start with appl_RECORDS. or start with appl and finish with _REC.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.9 Cobol

Requirements for Cobol are summarized in Table 9-14.

Table 9-14 Cobol Requirements
File Type Feature Sematics

.COB Cobol source.

filename Must start with application code. Should reside in the CMS library.

program-id Must be the same as the filename.

copy ... Copy in a source file. The file should reside in the work directory.

copy ... from dictionary Used to indicate a dependency on a CDD/Repository element. If the object is a record, its name must either start with appl_RECORDS. or start with appl and finish with _REC. If the object is a field, its name must either start with appl_FIELDS. or not finish with _REC.

copy ... in ... Copy a source from a library. The library should reside in the library directory. It should have a file name of applTXT.TLB.

call Used to create a transitive dependency via .TAG_EP. Called program name must be in quotes.

.TAG_CDD Used to manage dependencies required by copy ... from dictionary statements.

.TAG_CPY_1 Used to manage dependencies caused by nested copy ... and copy ... in ... statements.

.TAG_CPY_2 Used to manage transitive dependencies caused by call statements in copy files and libraries.

.LIS, .OBJ Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.

applOBJ.OLB Created in the library directory to store the resultant object module.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-14 Cobol Requirements**
File Type	Feature	Sematics
.COB		Cobol source.
	filename	Must start with application code. Should reside in the CMS library.
	program-id	Must be the same as the filename.
	copy ...	Copy in a source file. The file should reside in the work directory.
	copy ... from dictionary	Used to indicate a dependency on a CDD/Repository element. If the object is a record, its name must either start with appl_RECORDS. or start with appl and finish with _REC. If the object is a field, its name must either start with appl_FIELDS. or not finish with _REC.
	copy ... in ...	Copy a source from a library. The library should reside in the library directory. It should have a file name of applTXT.TLB.
	call	Used to create a transitive dependency via .TAG_EP. Called program name must be in quotes.
.TAG_CDD		Used to manage dependencies required by copy ... from dictionary statements.
.TAG_CPY_1		Used to manage dependencies caused by nested copy ... and copy ... in ... statements.
.TAG_CPY_2		Used to manage transitive dependencies caused by call statements in copy files and libraries.
.LIS, .OBJ		Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.
applOBJ.OLB		Created in the library directory to store the resultant object module.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.10 DCL

Requirements for DCL command procedures are summarized in Table 9-15.

Table 9-15 DCL Command Procedure Requirements
File Type Feature Sematics

.COM_SRC DCL command procedure source.

.COM_APP DCL command procedure append source.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-15 DCL Command Procedure Requirements**
File Type	Feature	Sematics
.COM_SRC		DCL command procedure source.
.COM_APP		DCL command procedure append source.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.11 DECdocument

Requirements for DECdocument are summarized in Table 9-16.

Table 9-16 DECdocument Requirements
File Type Feature Sematics

.SDML DECdocument source. See Table 9-17 for file name suffix conventions.

<CONTENTS_FILE> Include /CONTENTS in the generated DOCUMENT command. This tag must only be used in a .SDML source - it is not recognised in a .SDML_INC include source.

<EXAMPLE_FILE>, <FIGURE_FILE>, <INCLUDE> Generate a dependency on the specified include file.

<INDEX_FILE> Include /INDEX in the generated DOCUMENT command. This tag must only be used in a .SDML source - it is not recognised in a .SDML_INC include source.

.SDML_INC DECdocument include source.

<EXAMPLE_FILE>, <FIGURE_FILE>, <INCLUDE> See .SDML source.

.GRA DECdocument graphic source.

.INX_LIST Used during the creation of a master index.

.COM, .EPS, .HLP, .INT_TOC, .INX, .LIS, .MAP_LIS, .TAG_INX, .TAG_SDML, .TEX Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.

.DECW$BOOK, .GIF, .HTML, .PS, .TXT Generated in the documentation directory by the COMPILE command or the BUILD DESCRIP phase.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-16 DECdocument Requirements**
File Type	Feature	Sematics
.SDML		DECdocument source. See Table 9-17 for file name suffix conventions.
	<CONTENTS_FILE>	Include /CONTENTS in the generated DOCUMENT command. This tag must only be used in a .SDML source - it is not recognised in a .SDML_INC include source.
	<EXAMPLE_FILE>, <FIGURE_FILE>, <INCLUDE>	Generate a dependency on the specified include file.
	<INDEX_FILE>	Include /INDEX in the generated DOCUMENT command. This tag must only be used in a .SDML source - it is not recognised in a .SDML_INC include source.
.SDML_INC		DECdocument include source.
	<EXAMPLE_FILE>, <FIGURE_FILE>, <INCLUDE>	See .SDML source.
.GRA		DECdocument graphic source.
.INX_LIST		Used during the creation of a master index.
.COM, .EPS, .HLP, .INT_TOC, .INX, .LIS, .MAP_LIS, .TAG_INX, .TAG_SDML, .TEX		Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.
.DECW$BOOK, .GIF, .HTML, .PS, .TXT		Generated in the documentation directory by the COMPILE command or the BUILD DESCRIP phase.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

File name suffix conventions are listed in Table 9-17.

Table 9-17 DECdocument File Name Suffices
File Name Siffix Usage

_CVR Cover note source for generating PostScript and text output.

_GDE Guide source for generating bookreader, master index and PostScript output.

_HLP Help source.

_IDX Master index sources for generating PostScript output. Two sources must exists, one with a file type of .SMDL and the other of a file type of .INX_LIST.

_INS Guide source for generating bookreader, PostScript and text output.

_OVH Overhead source for generating PostScript output.

_RELEASE_NOTES Release notes source for generating bookreader, PostScript and .RELEASE_NOTES output.

_REF Reference manual source for generating bookreader, master index and PostScript output.

**Table 9-17 DECdocument File Name Suffices**
File Name Siffix	Usage
_CVR	Cover note source for generating PostScript and text output.
_GDE	Guide source for generating bookreader, master index and PostScript output.
_HLP	Help source.
_IDX	Master index sources for generating PostScript output. Two sources must exists, one with a file type of .SMDL and the other of a file type of .INX_LIST.
_INS	Guide source for generating bookreader, PostScript and text output.
_OVH	Overhead source for generating PostScript output.
_RELEASE_NOTES	Release notes source for generating bookreader, PostScript and .RELEASE_NOTES output.
_REF	Reference manual source for generating bookreader, master index and PostScript output.

9.11.1 Graphics

Because DECdocument graphics renditions may need different scaling on a per figure or format basis, SysWorks cannot use implicit MMS rules for generating them. Therefore, each application using VAX DOUMENT graphics needs to declare an explicit set of rules. A typical way of doing this is to have a line in the applications DESCRIP.MMS which includes another application MMS script.

For example:

!++ ! ! MMS Script: ! SWDOC_GRAPHICS ! ! Purpose: ! Create graphics targets for DECdocument. ! !-- SWRK_LIB_DIR:SWRK_DECW_SM.BRF,- SWRK_LIB_DIR:SWRK_DECW_SM.EPS,- SWRK_LIB_DIR:SWRK_DECW_SM.SDML - depends_on - SWRK_WRK_DIR:SWRK_DECW_SM.GRA @ if f$trnlnm("decw$display") .eqs. "" then set display/create $(docbrfeps) $(mms$source)/output=$(mms$target)/scale=(x=75,y=75,exclude=brf) SWRK_LIB_DIR:SWRK_DISKS_FIGURE.BRF depends_on SWRK_WRK_DIR:SWRK_DISKS_FIGURE.GRA @ if f$trnlnm("decw$display") .eqs. "" then set display/create $(docbrf) $(mms$source)/output=$(mms$target)/scale=(x=67,y=67) SWRK_LIB_DIR:SWRK_DISKS_FIGURE.EPS depends_on SWRK_WRK_DIR:SWRK_DISKS_FIGURE.GRA @ if f$trnlnm("decw$display") .eqs. "" then set display/create $(doceps) $(mms$source)/output=$(mms$target)/scale=(x=50,y=50)

In this example

A line such as .INCLUDE SWRK_WRK_DIR:SWRK_GRAPHICS.MMS whould be required in the applications DESCRIP.MMS.
The SWRK_DECW_SM graphics file needs a 25% reduction for its postscript rendition while retaining its original size for the bookreader version. This can be achived in a single rule as indicatred. This method would also be used if neither format required scaling or both formats required the same scaling.
The docbrfeps macro is defined in the standard SysWorks MMS rules file as generating both a .BRF and a .EPS rendition.
The SWRK_DISKS_FIGURE graphics file however, requires two rules since the two renditions require different scaling.
The docbrf macro is defined in the standard SysWorks MMS rules file as generating a .BRF and the doceps macro a .EPS one.
The DECW$DISPLAY definition is required to make the DOCUMENT/GRAPHICS=RENDER command work. If a node on which the documentation is to be built does not have a display device, it is necessary to create the display on a node which does.

9.12 DECforms

Requirements for DECforms are summarized in Table 9-18.

Table 9-18 DECforms Requirements
File Type Feature Sematics

.IFDL DECforms source.

form Must be the same as the filename. Should start with the application code and finish with _FRM.

copy ... Copy in a source file. The file should reside in the work directory.

copy ... from dictionary Used to indicate a dependency on a CDD/Repository element. If the object is a record, its name must either start with appl_RECORDS. or start with appl and finish with _REC. If the object is a field, its name must either start with appl_FIELDS. or not finish with _REC.

copy ... in ... Copy a source from a library. The library should reside in the library directory. It should have a file name of applTXT.TLB.

call Used to create a transitive dependency via .TAG_EP. Called program name must be in quotes.

.TAG_CDD Used to manage dependencies required by copy ... from dictionary statements.

.TAG_CPY_1 Used to manage dependencies caused by nested copy ... and copy ... in ... statements.

.TAG_CPY_2 Used to manage transitive dependencies caused by call statements in copy files and libraries.

.FORM DECforms intermediate binary format.

.LIS, .OBJ Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.

applOBJ.OLB Created in the library directory to store the resultant object module.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-18 DECforms Requirements**
File Type	Feature	Sematics
.IFDL		DECforms source.
	form	Must be the same as the filename. Should start with the application code and finish with _FRM.
	copy ...	Copy in a source file. The file should reside in the work directory.
	copy ... from dictionary	Used to indicate a dependency on a CDD/Repository element. If the object is a record, its name must either start with appl_RECORDS. or start with appl and finish with _REC. If the object is a field, its name must either start with appl_FIELDS. or not finish with _REC.
	copy ... in ...	Copy a source from a library. The library should reside in the library directory. It should have a file name of applTXT.TLB.
	call	Used to create a transitive dependency via .TAG_EP. Called program name must be in quotes.
.TAG_CDD		Used to manage dependencies required by copy ... from dictionary statements.
.TAG_CPY_1		Used to manage dependencies caused by nested copy ... and copy ... in ... statements.
.TAG_CPY_2		Used to manage transitive dependencies caused by call statements in copy files and libraries.
.FORM		DECforms intermediate binary format.
.LIS, .OBJ		Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.
applOBJ.OLB		Created in the library directory to store the resultant object module.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.13 FMS

Requirements for FMS are summarized in Table 9-19.

Table 9-19 FMS Requirements
File Type Feature Sematics

.FRM FMS form source.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-19 FMS Requirements**
File Type	Feature	Sematics
.FRM		FMS form source.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.14 Fortran

Requirements for Fortran are summarized in Table 9-20.

Table 9-20 Fortran Requirements
File Type Feature Sematics

.FOR Fortran source.

.LIS, .OBJ Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.

applOBJ.OLB Created in the library directory to store the resultant object module.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-20 Fortran Requirements**
File Type	Feature	Sematics
.FOR		Fortran source.
.LIS, .OBJ		Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.
applOBJ.OLB		Created in the library directory to store the resultant object module.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.15 Macro

Requirements for Macro-32 are summarized in Table 9-21.

Table 9-21 Macro-32 Requirements
File Type Feature Sematics

.MAR Macro-32 source.

.title Used to determine the name of the module. This directive must be present and specify the same name as the source file name.

_MAC.MAR Macro-32 macro only source.

.title Used to determine the name of the module. This directive must be present and specify the same name as the source file name.

applMAC.MLB Created in the software directory to store macros found in _MAC.MAR macro only sources.

.macro Beginning of a macro in a macro only source. Nested macros are ignored.

$defini If found on the line immediately following a .macro directive, the $defini directive indicates that dependencies for an object module should to define the symbols contained within the macro should be generated. If the macro name starts with a period, no dependency to update the macro library is generated as MMS does not support objects starting with a period. If a $defini directive is not found, only the dependencies required to insert the macro into the macro library are generated.

.endm End of a a macro in a macro only source.

.LIS, .OBJ Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.

applOBJ.OLB Created in the library directory to store the resultant object module.

.MMS_INC Generated in the library directory by the BUILD RULES phase. The format differs between general Macro sources and macro only sources.

**Table 9-21 Macro-32 Requirements**
File Type	Feature	Sematics
.MAR		Macro-32 source.
	.title	Used to determine the name of the module. This directive must be present and specify the same name as the source file name.
_MAC.MAR		Macro-32 macro only source.
	.title	Used to determine the name of the module. This directive must be present and specify the same name as the source file name.
applMAC.MLB		Created in the software directory to store macros found in _MAC.MAR macro only sources.
	.macro	Beginning of a macro in a macro only source. Nested macros are ignored.
	$defini	If found on the line immediately following a .macro directive, the $defini directive indicates that dependencies for an object module should to define the symbols contained within the macro should be generated. If the macro name starts with a period, no dependency to update the macro library is generated as MMS does not support objects starting with a period. If a $defini directive is not found, only the dependencies required to insert the macro into the macro library are generated.
	.endm	End of a a macro in a macro only source.
.LIS, .OBJ		Generated in the library directory by the COMPILE command or the BUILD DESCRIP phase.
applOBJ.OLB		Created in the library directory to store the resultant object module.
.MMS_INC		Generated in the library directory by the BUILD RULES phase. The format differs between general Macro sources and macro only sources.

9.16 ObjectBroker

9.16.1 Contexts

Requirements for ObjectBroker contexts are summarized in Table 9-22.

Table 9-22 ObjectBroker Context Requirements
File Type Feature Sematics

.COL ObjectBroker context source.

.CO ObjectBroker context database.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-22 ObjectBroker Context Requirements**
File Type	Feature	Sematics
.COL		ObjectBroker context source.
.CO		ObjectBroker context database.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.16.2 Repositories

Requirements for ObjectBroker repository are summarized in Table 9-23.

Table 9-23 ObjectBroker Repository Requirements
File Type Feature Sematics

.IDL ObjectBroker repository source.

.IR ObjectBroker repository database.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-23 ObjectBroker Repository Requirements**
File Type	Feature	Sematics
.IDL		ObjectBroker repository source.
.IR		ObjectBroker repository database.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

9.17 Oracle Rdb

Requirements for Oracle Rdb are summarized in Table 9-24.

Table 9-24 Oracle Rdb Requirements
File Name Suffix and File Type Feature Sematics

_CK n.SQL Check constraint definition.

_DOM.SQL Domain definition.

_FK n.SQL Foreign key constraint definition.

_MAP.SQL Storage map definition.

_PK.SQL Primary key constraint definition.

_PIDX.SQL Primary index definition.

_RTN Routine definition.

_SIDX n Secondary (alternative) index definition.

_TBL.SQL Table definition.

_TRG.SQL _TRGR.SQL Trigger definition.

_VIEW.SQL _VW.SQL View definition.

.SQLMOD Module source.

procedure Used to create a transitive dependency via .TAG_EP.

.MMS_INC Generated in the library directory by the BUILD RULES phase.

**Table 9-24 Oracle Rdb Requirements**
File Name Suffix and File Type	Feature	Sematics
_CK n.SQL		Check constraint definition.
_DOM.SQL		Domain definition.
_FK n.SQL		Foreign key constraint definition.
_MAP.SQL		Storage map definition.
_PK.SQL		Primary key constraint definition.
_PIDX.SQL		Primary index definition.
_RTN		Routine definition.
_SIDX n		Secondary (alternative) index definition.
_TBL.SQL		Table definition.
_TRG.SQL _TRGR.SQL		Trigger definition.
_VIEW.SQL _VW.SQL		View definition.
.SQLMOD		Module source.
	procedure	Used to create a transitive dependency via .TAG_EP.
.MMS_INC		Generated in the library directory by the BUILD RULES phase.

The following SQL include lists are generated in the application architecture independent library directory during the BUILD SCAN phase:

appl_CONSTRAINTS.SQL
appl_DOMAINS.SQL
appl_INDICES.SQL
appl_ROUTINES.SQL
appl_STORAGE_MAPS.SQL
appl_TABLES.SQL
appl_TRIGGERS.SQL
appl_VIEWS.SQL

The following MMS dependency list is generated in the application architecture independent library directory during the BUILD SCAN phase:

appl_SCHEMA.MMS

Contents

Index

SysWorksApplication Development Guide

9.7 CDD

9.16.1 Contexts

SysWorks
Application Development Guide