Report Requests

Syntax used for exported Report Requests varies depending on the type of source file used for the report — Archive File or Compare File.

CREATE REPT identifier.name
   [DESC //description//] 
   [TITLE //reporttitle//]
   LOCALFILE {Y|N}  
   LOCALPRINTER {Y|N} 
      [PRINTERSETUP (PRINTERNAME printername
      DRIVERNAME driver PORT port ORIENTATION {P|L})]
   REPORTFILENAME rtffilename
   REPORTFILEFORMAT {1|2} [SERVERNAME server] 
   DEFTYPE {A|R} 
   ANDFLAG {Y|N} DELIMITER {+ | : | ; | |}
   ARCCRIT (TYPE criteria VALUES value SORTASC {Y|N})
   SOURCEFILENAME sourcefilename
   SOURCEFILETYPE {CMP|AF} 
   AUTOREPNEWTABLES  {Y|N}  
   SHOWSUMMARY  {Y|N} SHOWDETAILS {Y|N}
   SHOWEMPTYTABLES {Y|N}
   COMPAREDETAILTYPE {C|A|D} 
      SHOWEQUALROWS {Y|N} 
      SHOWDIFFERENTROWS {Y|N} 
      SHOWROWSONLYINS1 {Y|N} 
      SHOWROWSONLYINS2 {Y|N}
      SHOWDUPLICATESFROMS1 {Y|N}
      SHOWDUPLICATESFROMS2 {Y|N}
      COMPTABLEDATA (tablename  tablename {Y|N}) 
   ARCHIVEDETAILTYPE {C|S}
      SHOWJOINS {Y|N} 
         TABLE (tablename {Y|N}) |
         TABLE (NAME tablename NEWPAGEPERROW{Y|N} 
         PREDOP {AND|OR} [COLUMN (NAME columnname
OP operator VALUE “value” )] [SQL //sqlwhereclause//]
         REL identifier.name
   ROWSPERTABLE n LINESPERPAGE n LINELENGTH n 
   CHARCOLWIDTH n LINESBETWEENROWS n 
   SPACEBETWEENCOLS n LINESBETWEENLEVELS n 
   SUBORDTABLEINDENTSPACE n ADJUSTLONGLINE
{T|W} 
   SHOWTABLEHEAD {Y|N} 
   SHOWTABLEHEADSUBORD {Y|N} 
   SHOWTABLEHEADREDUND {Y|N}    
   [EMAILNOTIFY ({A|S|F} emailaddress)];

Keywords

The keywords correspond to values that can be specified for a Report Request. For additional information, see the Archive or Compare documentation.

REPT identifier.name
The name of the Report Request, specified in two parts (identifier.name) is required following the CREATE REPT keyword.
DESC //description//
A description of the Report Request, delimited by double slashes.

General

The keywords correspond to values that can be specified for a Report Request. For additional information, see the Archive User Manual or Compare User Manual.

TITLE //description//
The title of the report, referenced at the top of each page of the report, delimited by double slashes.
DEFTYPE {A|R}
Indicates the type of Report Request: A for Archive Directory or R for Source File.
LOCALFILE {Y|N}
Indicates whether report output is directed to a file.
LOCALPRINTER {Y|N}
Indicates whether report output is directed to a printer.
PRINTERSETUP
Follow this keyword with the set of keywords for the printer setup, enclosed in parentheses.
PRINTERNAME printername
Name of the local printer.
DRIVERNAME drivername
Name of the driver for the local printer.
PORT port
Name of the port for the local printer.
ORIENTATION {P|L}
Print orientation: P for portrait or L for landscape.
REPORTFILENAME rtffilename
The fully qualified name of a text file for the output of the report process.
REPORTFILEFORMAT {1|2}
Numerical value to indicate the report output format. A value of 1 indicates plain text; a value of 2 indicates Rich Text.

Source File - General

These keywords correspond to values that can be specified for Report Requests where the Report Type is File, regardless of the Source File type.

SERVERNAME server
Identifies the name of the server containing the source file, as applicable.
SOURCEFILENAME sourcefilename
The fully qualified name of the Compare File or Archive File used for the report process.
SOURCEFILETYPE {CMP|AF}
Indicates whether the source file is a Compare File (CMP) or Archive File (AF).
AUTOREPNEWTABLES {Y|N}
Indicates whether to automatically report on new tables.

Source File - Archive File

These keywords correspond to values that can be specified for Report Requests where the Report Type is File and the Source File is an Archive File.

ARCHIVEDETAILTYPE {C|S}
For an Archive File in a Report Request, C indicates columnar format, S indicates side label format.
SHOWJOINS {Y|N}
Indicates whether archived tables may be joined in the Report.
TABLE (tablename {Y|N})
This keyword precedes each fully qualified table name in the Archive File, and an indicator for whether the table is included in the report. If tables in the Report Request are joined, the table name is followed by additional keywords to indicate the relationship between the joined tables, selection criteria, and formatting options, as applicable.
NAME tablename
This keyword precedes each fully qualified table name in the Archive File, and an indicator for whether the table is included in the report. If tables in the Report Request are joined, the table name is followed by additional keywords to indicate the relationship between the joined tables, selection criteria, and formatting options, as applicable.
NEWPAGEPERROW {Y|N}
For joined tables, this keyword specifies whether a new page is used for each row and its related row(s).
PREDOP {AND|OR}
For joined tables with selection criteria specified, the predicate operator indicates whether to AND or OR the criteria.
[COLUMN (NAME columnname OP operator VALUE “value”)] [SQL //sqlwhereclause//]
For joined tables, this keyword precedes each column name for which criteria is specified. Follow the column name with additional keywords to indicate the applicable relational operator and value used, or the text of the SQL Where clause delimited by double slashes.
REL identifier.name
The fully qualified name of the relationship used to join a pair of tables.

Source File - Compare File

These keywords correspond to values that can be specified for Report Requests where the Report Type is File and the Source File is a Compare File.

SHOWSUMMARY {Y|N}
Indicates whether to summarize the report output.
SHOWDETAILS {Y|N}
Indicates whether report output is detailed.
SHOWEMPTYTABLES {Y|N}
Indicates whether headers for empty tables are included in the report output.
COMPAREDETAILTYPE {C|A|D}
For a Compare File in a Report Request, C indicates columnar format, A indicates side label format - all columns, and D indicates side label format - different columns.
SHOWEQUALROWS {Y|N}
Indicates whether to show rows in the report output that the Compare Process found to be equal.
SHOWDIFFERENTROWS {Y|N}
Indicates whether to show rows in the report output that the Compare Process found to be unequal.
SHOWROWSONLYINS1 {Y|N}
Indicates whether to show rows in the report output that the Compare Process found only in Source 1.
SHOWROWSONLYINS2 {Y|N}
Indicates whether to show rows in the report output that the Compare Process found only in Source 2.
SHOWDUPLICATESFROMS1 {Y|N}
Indicates whether to show rows in the report output from Source 1 that contain the same Match Key.
SHOWDUPLICATESFROMS2 {Y|N}
Indicates whether to show rows in the report output from Source 2 that contain the same Match Key.
COMPTABLEDATA tablename tablename {Y|N}
This keyword precedes each matched pair of fully qualified table names in the Compare File, and an indicator for whether the pair is included in the report.

Archive Directory

These keywords correspond to values that can be specified for Report Requests where the Report Type is Archive Directory.

ANDFLAG {Y|N}
Indicates whether criteria in the Report Request is joined (e.g., ANDed).
DELIMITER {+ | : | ; | |}
Indicates the delimiter used in the Report Request.
ARCCRIT
Indicates archive criteria are referenced in the Report Request. The criteria are contained in parentheses that follow this keyword.
TYPE criteria
Indicates the type of criteria used to find Archive Directory entries.
VALUES value
Indicates the value for the associated criteria.
SORTASC {Y|N}
Indicate whether the criteria is sorted in ascending order.

Details Formatting

These keywords control the appearance of the report.

ROWSPERTABLE n
Maximum number of rows for each table in the report.
LINESPERPAGE n
Maximum number of lines per page in the report.
LINELENGTH n
Maximum number of characters per line in the report.
CHARCOLWIDTH n
Maximum number of characters per column in the report.
LINESBETWEENROWS n
Number of blank lines inserted between each row in the report.
SPACEBETWEENCOLS n
Number of blank spaces inserted between columns in the report.
LINESBETWEENLEVELS n
Number of blank lines inserted between each level of joined tables.
SUBORDTABLEINDENTSPACE n
Number of blank spaces to indent rows from each subordinate joined table in the report.
ADJUSTLONGLINE {T|W}
When row data exceeds the line length limitation, T indicates truncate the row, W indicates wrap to the next line.
SHOWTABLEHEAD {Y|N}
Indicates whether column names are displayed with Start table data.
SHOWTABLEHEADSUBORD {Y|N}
Indicates whether column names are displayed for the first row of data from a joined table.
SHOWTABLEHEADREDUND {Y|N}
Indicates whether column names are displayed with every row of data reported from a joined table.

Notify

This parameter relates to the ability to send notification via email about the outcome of the process.

EMAILNOTIFY {A|S|F} emailaddress
Indicates the process outcome under which to send notification to the corresponding email address.
A
Always send notification.
S
Send notification when process succeeds.
F
Send notification when process fails.