/LOGOPTIONS - Connect_ETL - 9.13

Connect ETL Data Transformation Language (DTL) Guide

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect (ETL, Sort, AppMod, Big Data)
Version
9.13
Language
English
Product name
Connect ETL
Title
Connect ETL Data Transformation Language (DTL) Guide
Copyright
2023
First publish date
2003
Last updated
2023-09-11
Published on
2023-09-11T19:01:45.019000

Purpose

To control the emission of messages to the log stream.

Format

/LOGOPTIONS [time_mask] message_group [message_group…]

where

time_mask = TIMEMASK datetime_mask  
message_group = {statistics } {status } {task } {documentation} {warnings }  
statistics = STATISTICS {[ON] [SOURCEANDTARGET]} {OFF }
status = STATUS {[ON][ TIMESTAMP]} {OFF }
task = TASKID {[ON] } {OFF }
documentation = TASKDOCUMENTATION {element[ , element ... ]}{OFF }
element = {TITLE } {AUTHOR } {COMPANY } {COMMENTS}  
warnings = WARNINGS number|ALL [DISPLAYRECORD [ON|OFF]]  

Arguments

datetime_mask

An edit mask that defines the date time format.

For informatin on date and time mask formats, see syntax reference in the Connect help.

number The maximum number of warning messages generated and written to the log.

Location

This option may appear anywhere in the task definition.

Defaults

The name and the last modification date of the task file displays.

Task comments, which are specified through the COMMENTS clause of the /TASKDOCUMENTATION option, display.

Status messages with timestamps display.

Execution statistics display. For each source and target, name and additional information, such as the last file modification date, display.

The format of any date and time information that is written to the log is as follows: YEAR/MM0/DD0 HH0:MI0:SE0. You can customize the format of the logged date and time mask using the TIMEMASK option clause.

Connect ETL issues a maximum of 100 warnings, which do not include validation warnings. Upon encountering data errors, the contents of the data record causing the error does not display.

Notes

STATISTICS

By default, Connect ETL writes execution statistics to the log. The appearance of OFF requests turning off statistics messages.

The presence of SOURCEANDTARGET requests that statistics messages generate additional information, for example, the name of the source or target and last modification date of the file source or target.

STATUS

By default, Connect ETL writes status messages to the execution log.

You can turn off status messages by specifying STATUS OFF. You will still see final statistics unless you turn them off using /LOGOPTIONS STATISTICS OFF. Also, messages report­ing any problems will be shown.

TASKID

By default, Connect ETL writes the file name and the last modification date of the file to the execution log.

To supress writing of the task file information to the execution log, specify the following:
TASKID OFF 

TIMEMASK

By default, Connect ETL uses the following date/time mask to format date and time information written to the log: YEAR/MM0/DD0 HH0:MI0:SE0.

To customize the format of the date and time information, specify the TIMEMASK clause and provide the applicable edit mask, which must include both the date and time components. You can not customize the date or the time component individually.

For information on date and time mask formats, see the Syntax of date pattern topic in the Connect help.

By default, Connect ETL writes task comments specified through the /TASKDOCUMENTATION option to the execution log.

To include other task documentation, such as title, author, or company, in the log, include the corresponding option keyword in addition to the COMMENTS keyword in the TASKDOCUMENTATION clause. For example:
TASKDOCUMENTATION TITLE, AUTHOR, COMPANY, COMMENTS 
To supress writing of the task documentation to the execution log, specify the following:
TASKDOCUMENTATION OFF 

WARNINGS

Use this parameter to limit the number of warning messages issued by Connect ETL, and to control whether the data records that cause the warnings are displayed.

By default, Connect ETL will issue a maximum of 100 warnings, not including valida­tion warnings, and will not display the data records.

The limit on the number of warnings does not include those that result from validation. The validation warnings are issued regardless of the number requested with /LOGOPTIONS WARNINGS. After the warning limits are reached, you will still see final statistics if you request them. Also, messages reporting any problems with severity greater than warning will continue to be issued.

If you specify WARNINGS ALL, all warning messages will be displayed. Limiting the number of warning messages is useful when you expect that Connect ETL will issue a warning for each record, e.g., when you expect that every record will be truncated.

DISPLAYRECORD or DISPLAYRECORD ON causes Connect ETL to display the data record that caused the warning along with the warning message. DISPLAYRECORD OFF turns off the display of the records.

Examples

/logoptions status off
This requests that the emission of processing status messages be turned off.
/taskdocumentation 
TITLE 'Summary report for web log activity' 
AUTHOR 'Ian Black (original) Bernard Taylor (updated)' 
COMPANY 'ABC Incorporated' 
COMMENTS 'Summarizes web log activity for one day by client.', 
newline
/logoptions taskdocumentation TITLE, AUTHOR, COMPANY, COMMENTS 
The option requests Connect ETL output all the task documentation sections to the log. An example of the resulting log follows.
[dmexpress HP-UX/LFS Copyright (c) 2004 Syncsort Inc.]
[For use by ABC Incorporated.]
Title:
Summary report for web log activity
Author:
Ian Black (original) Bernard Taylor (updated)
Company:
ABC Incorporated
Comments:
Summarizes web log activity for a single day by client.
dmexpress options validated. Processing continues.
dmexpress statistics
Records read: 97456 Data read (bytes): 1432566
Records sorted: 97456 Data sorted (bytes): 1432566
Records output: 253 Data output (bytes): 6457
Input record length: 157 Output record length: 106
Memory guideline from job (MB) 100
Virtual memory allocated (MB) 9 Physical memory used (MB) 3
Work space used (bytes): 0
Elapsed time: 00:00:06.46 CPU time: 00:00:02.35
dmexpress has completed
/logoptions warnings 20
The option specifies that no more than 20 warning messages are to be issued.
/LOGOPTIONS warnings all displayrecord on

The option specifies that all warning messages issued by Connect ETL should be displayed and the display of the data records should be enabled.