Autofilling Functions

There is a set of functions you can use to fill records with some special, pre-defined values (e.g. name of the file you are reading, size of the data source etc.). These functions are available in Metadata editor > Details pane > Advanced properties.

The following functions are supported by most Readers.

The function fills in the value into the metadata field just on the output port of the Reader. The other component that does not read the data source would not know the value to be filled in.

The ErrCode and ErrText functions can be used only in the following components: DBExecute and DatabaseWriter.

Note a special case of true autofilling value in the MultiLevelReader component.

• default_value - a value of a corresponding data type specified as the Default property is set if no value is read by the Reader.

• global_row_count. This function counts the records of all sources that are read by one Reader. It fills the specified field of any numeric data type in the edge(s) with integer numbers sequentially. The records are numbered in the same order they are sent out through the output port(s). The numbering starts at 0. However, if data records are read from more data sources, the numbering goes continuously throughout all data sources. If an edge does not include such a field (in XMLExtract, e.g.), corresponding numbers are skipped and the numbering continues.

• global_row_incl_err_count. This function is similar to global_row_count, but counts error records (if exist) as well.

• source_row_count. This function counts the records of each source, read by one Reader, separately. It fills the specified field of any numeric data type in the edge(s) with integer numbers sequentially. The records are numbered in the same order they are sent out through the output port(s). The records of each source file are numbered independently on the other sources. The numbering starts at 0 for each data source. If an edge does not include such a field (in XMLExtract, e.g.), corresponding numbers are skipped. And the numbering continues.

• source_row_incl_err_count. This function is similar to source_row_count, but counts error records (if exist) as well.

• metadata_row_count. This function counts the records of all sources that are both read by one Reader and sent to edges with the same metadata assigned. It fills the specified field of any numeric data type in the edge(s) with integer numbers sequentially. The records are numbered in the same order they are sent out through the output port(s). The numbering starts at 0. However, if data records are read from more data sources, the numbering goes continuously throughout all data sources.

• metadata_source_row_count. This function counts the records of each source that are both read by one Reader and sent to edges with the same metadata assigned. It fills the specified field of any numeric data type in the edge(s) with integer numbers sequentially. The records are numbered in the same order they are sent out through the output port(s). The records of each source file are numbered independently on the other sources. The numbering starts at 0 for each data source.

• source_name. This function fills the specified record fields of string data type with the name of data source from which records are read.

• source_timestamp. This function fills the specified record fields of date data type with the timestamp corresponding to the data source from which records are read. Field formatting depends on field "Metadata / Data Formats" settings. This function cannot be used in DatabaseReader.

• source_size. This function fills the specified record fields of any numeric data type with the size of data source from which records are read. This function cannot be used in DatabaseReader.

• row_timestamp. This function fills the specified record fields of date data type with the time when individual records are read. Field formatting depends on field "Metadata / Data Formats" settings.

• reader_timestamp. This function fills the specified record fields of date data type with the time when the reader starts reading. The value is the same for all records read by the reader. Field formatting depends on field "Metadata / Data Formats" settings.

• ErrCode. This function fills the specified record fields of integer data type with error codes returned by the component. It can be used by DatabaseWriter and DBExecute components only.

• ErrText. This function fills the specified record fields of string data type with error messages returned by component. It can be used by DatabaseWriter and DBExecute components only.

• sheet_name. This function fills the specified record fields of string data type with the name of the sheet of input XLS(X) file from which data records are read. It can be used by the SpreadsheetDataReader component only.