2022 June Release

Properties of FSCCOLD@1.1001:DataImport Permanent link for this heading

Type

Property

Name

integer(5)

datimpbulksize

Number of Records for Commit

ClassProperties[]

datimpclassproperties

Class Properties

string

datimpdatasource

Data Source

DataSourceType

datimpdatasourcetype

Data Source Type

boolean

datimpfastwrapper

Skip Methods Without Check

boolean

datimpfilterallcolumns

Use All Columns for Filter

content

datimpfiltercommit

Filter Script for Objects After Commit

string[]

datimpfiltercommitexpr

Filter Expression for Objects After Commit

content

datimpfilterdata

Filter Script for RAW Data

string[]

datimpfilterdataexpr

Filter Expression for RAW Data

content

datimpfilterobjects

Filter Script for Objects

string[]

datimpfilterobjectsexpr

Filter Expression for Objects

DataImportLog

datimplogobj

Log Object

Mapping[]

datimpmapping

Mapping

integer

datimpmaxhistory

Maximum Number of Entries in Log

integer(5)

datimpminbulksize

At Least

boolean

datimpnoobjectrefresh

Skip Object Refresh

boolean

datimpnoteless

Skip Setting Modification Properties

Object

datimpobjdatasource

Data Source Object

ObjectReference[]

datimpobjectreferences

Object Relations

RecordModeType

datimprecordmode

Logging Mode

integer

datimprecords

Number of Records to Be Read

string(4096)

datimpsourcetable

Table

integer

datimpstartrecord

First Record

boolean

datimptermonerror

Abort Data Import Immediately on Error

integer(3)

datimpthreads

Number of Threads

boolean

datimpuiupdate

Activate Logging of Changed Properties

boolean

datimpusefiltercommit

Use Filter Script for Objects After Commit

boolean

datimpusefilterdata

Use Filter Script for RAW Data

boolean

datimpusefilterobjects

Use Filter Script for Objects


Number of Records for Commit (FSCCOLD@1.1001:datimpbulksize) Permanent link for this heading

The property datimpbulksize ("Number of Records for Commit") defines the maximum number of records being processed in a single transaction. The actual number of records per transaction may be lower in the last package or if the option MAPOPT_GROUPBY ("Group By") is specified in a mapping. As experience shows the best performance is reached with a value between 100 and 150. The number of used properties also influences the performance.

unsigned integer(5) FSCCOLD@1.1001:datimpbulksize readonly(inst)

Additional Information


Class Properties (FSCCOLD@1.1001:datimpclassproperties) Permanent link for this heading

The property datimpclassproperties ("Class Properties") defines the class properties.

unique ClassProperties[] FSCCOLD@1.1001:datimpclassproperties readonly(inst)

Additional Information


Data Source (FSCCOLD@1.1001:datimpdatasource) Permanent link for this heading

The property datimpdatasource ("Data Source") defines the name of the used data source. If the data source type is ODBC, the value defines the connection string that consists of DSN etc. For the data source type OLE DB the value contains the name of the data links (*.udl). These links must be either in the default directory for data links or contain a path. If the data source type is Report Converter the property specifies the name of the report conversion object.

string FSCCOLD@1.1001:datimpdatasource readonly(inst)

Additional Information


Data Source Type (FSCCOLD@1.1001:datimpdatasourcetype) Permanent link for this heading

The property datimpdatasourcetype ("Data Source Type") defines the type of the used data source. You can use the reader types ODBC, OLE DB, and Report Converter to import the data.

DataSourceType FSCCOLD@1.1001:datimpdatasourcetype readonly(inst)

Additional Information


Skip Methods Without Check (FSCCOLD@1.1001:datimpfastwrapper) Permanent link for this heading

Select this option to skip all checks during execution of the dynamic pre-wrappers.
This option can have sideeffects, if an action, which is selected to be skipped, is also being used in an other context.

boolean FSCCOLD@1.1001:datimpfastwrapper readonly(inst)

Additional Information


Use All Columns for Filter (FSCCOLD@1.1001:datimpfilterallcolumns) Permanent link for this heading

The property datimpfilterallcolumns ("Use All Columns for Filter") defines whether or not values of all columns are passed to the filter.

boolean FSCCOLD@1.1001:datimpfilterallcolumns readonly(inst)

Additional Information


Filter Script for Objects After Commit (FSCCOLD@1.1001:datimpfiltercommit) Permanent link for this heading

The property datimpfiltercommit ("Filter Script for Objects After Commit") defines the script that is called for each data record after the transaction has been committed. Such a script must contain a function
Main(classes, ids, objects, tx)
' classes [IN] Array of Strings: object class names
' ids [IN] Array of Integer: object class id's
' objects [IN] Array of Objects
' tx [IN] Transaction Object of the writer thread
The following global variables are available in the script:
cootx transaction of the read thread
coort runtime object for the import process
coolog log object with IXMLLogWriter-Interface (see FSCLOG@1.1001)
cooparam parameter object (see ImportRemote)

content FSCCOLD@1.1001:datimpfiltercommit readonly(inst)

Additional Information


Filter Expression for Objects After Commit (FSCCOLD@1.1001:datimpfiltercommitexpr) Permanent link for this heading

The property datimpfiltercommitexpr ("Filter Expression for Objects After Commit") defines an expression which is called for each data record after the transaction has been committed. The global scope contains the following parameters:
  • ::cooparam (COMINTERFACE, usually a DICTIONARY): Parameter object (see ImportRemote). If ::cooparam contains a (split) dictionary this parameter can be used to store global variable values. If so, only one thread must be used for importing the data.
  • ::coolog (COMINTERFACE): Log object with IXMLLogWriter-Interface (see FSCLOG@1.1001).
  • ::classes (OBJECTLIST): Object classes (see ObjectClass).
  • ::ids (INTEGERLIST): Object class id's (see datimpmapobjectid).
  • ::objects (OBJECTLIST): Objects.
  • ::inittx (COMINTERFACE): Main transaction of the data import (equal to cootx in the filter for raw data).

string[] FSCCOLD@1.1001:datimpfiltercommitexpr readonly(inst)(
  interface ::cooparam,
  interface ::coolog,
  ObjectClass[] ::classes,
  integer[] ::ids,
  object[] ::objects,
  dictionary ::values,
  interface ::inittx)

Local Scope: dictionary
Global Scope: dictionary

Name

Description

::cooparam

::coolog

::classes

::ids

::objects

::values

::inittx

Additional Information


Filter Script for RAW Data (FSCCOLD@1.1001:datimpfilterdata) Permanent link for this heading

Defines the VB script that is called for each record of the database. This script can be used to modify the raw data. Such a script must contain a function
Main(columns, data, changed, skip)
' columns [IN] Array of Strings: column names
' data [IN] Array of Strings: values of columns
' changed [OUT] Boolean: Set this flag to 'true' if 'data' has been changed
' skip [OUT] Boolean: Set this flag to 'true' to skip the whole record
The following global variables are available in the script:
cootxtransaction of the read thread
coortruntime object for the import process
coolog log object with IXMLLogWriter-Interface (see FSCLOG@1.1001)
cooparam parameter object (see ImportRemote)

content FSCCOLD@1.1001:datimpfilterdata readonly(inst)

Additional Information


Filter Expression for RAW Data (FSCCOLD@1.1001:datimpfilterdataexpr) Permanent link for this heading

The property datimpfilterdataexpr ("Filter Expression for RAW Data") stores an expression which is called for each record of the database. This expression can be used to modify the raw data. The global scope contains the following parameters:
  • ::cooparam (COMINTERFACE, usually a DICTIONARY): Parameter object (see ImportRemote). If ::cooparam contains a (split) dictionary this parameter can be used to store global variable values. If so, only one thread must be used for importing the data.
  • ::coolog (COMINTERFACE): Log object with IXMLLogWriter-Interface (see FSCLOG@1.1001).
  • ::values (DICTIONARY): Column name and value pairs.
  • ::changed (BOOLEAN): Set this flag to 'true' if '::values' has been changed.
  • ::skip (BOOLEAN): Set this flag to 'true' to skip the whole record.

string[] FSCCOLD@1.1001:datimpfilterdataexpr readonly(inst)(
  interface ::cooparam,
  interface ::coolog,
  ref dictionary ::values,
  ref boolean ::changed,
  ref boolean ::skip)

Local Scope: dictionary
Global Scope: dictionary

Name

Description

::cooparam

::coolog

::values

::changed

::skip

Additional Information


Filter Script for Objects (FSCCOLD@1.1001:datimpfilterobjects) Permanent link for this heading

Defines the VB script that is called for each handled record after all properties from the current record have been set and before the transaction is committed. Such a script must contain a function
Main(classes, ids, objects, tx)
' classes [IN] Array of Strings: object class names
' ids [IN] Array of Integer: object class id's
' objects [IN] Array of Objects
' tx [IN] Transaction Object of the writer thread
The following global variables are available in the script:
cootxtransaction of the read thread
coortruntime object for the import process
coolog log object with IXMLLogWriter-Interface (see FSCLOG@1.1001)
cooparam parameter object (see ImportRemote)

content FSCCOLD@1.1001:datimpfilterobjects readonly(inst)

Additional Information


Filter Expression for Objects (FSCCOLD@1.1001:datimpfilterobjectsexpr) Permanent link for this heading

The property datimpfilterobjectsexpr ("Filter Expression for Objects") stores an expression which is called for each handled record after all properties from the current record have been set and before the transaction is committed. The global scope contains the following parameters:
  • ::cooparam (COMINTERFACE, usually a DICTIONARY): Parameter object (see ImportRemote). If ::cooparam contains a (split) dictionary this parameter can be used to store global variable values. If so, only one thread must be used for importing the data.
  • ::coolog (COMINTERFACE): Log object with IXMLLogWriter-Interface (seeFSCLOG@1.1001).
  • ::classes (OBJECTLIST): Object classes (see ObjectClass).
  • ::ids (INTEGERLIST): Object class id's (see datimpmapobjectid).
  • ::objects (OBJECTLIST): Objects.
  • ::values (DICTIONARY): Column name and value pairs.
  • ::inittx (COMINTERFACE): Main transaction of the data import (equal to cootx in the filter for raw data).

string[] FSCCOLD@1.1001:datimpfilterobjectsexpr readonly(inst)(
  interface ::cooparam,
  interface ::coolog,
  ObjectClass[] ::classes,
  integer[] ::ids,
  object[] ::objects,
  dictionary ::values,
  interface ::inittx)

Local Scope: dictionary
Global Scope: dictionary

Name

Description

::cooparam

p1

::coolog

::classes

::ids

::objects

::values

::inittx

Additional Information


Log Object (FSCCOLD@1.1001:datimplogobj) Permanent link for this heading

The property datimplogobj ("Log Object") a reference to the object containing the log of previous data imports. A new log object is created during data import if no log object is referenced or the log object ist invalid.

DataImportLog FSCCOLD@1.1001:datimplogobj readonly(inst)

Additional Information


Mapping (FSCCOLD@1.1001:datimpmapping) Permanent link for this heading

The property datimpmapping ("Mapping") is used to map the table columns of the data source to object properties. Each list entry contains the name of the table column, the object class and the property the column is mapped to, and the information whether the property is a key property.

Mapping[] FSCCOLD@1.1001:datimpmapping readonly(inst)

Additional Information


Maximum Number of Entries in Log (FSCCOLD@1.1001:datimpmaxhistory) Permanent link for this heading

The property datimpmaxhistory ("Maximum Number of Entries in Log") stores the maximum number of entries in the history information list. If this number is reached and further entries are added the eldest entries are removed from the list automatically. If this property does not have a value or its value is 0 there is no restriction for the history information list.

unsigned integer FSCCOLD@1.1001:datimpmaxhistory readonly(inst)

Additional Information


At Least (FSCCOLD@1.1001:datimpminbulksize) Permanent link for this heading

The property datimpminbulksize ("At Least") defines the minimum number of records that are processed in a single transaction if the option MAPOPT_GROUPBY is set.

unsigned integer(5) FSCCOLD@1.1001:datimpminbulksize readonly(inst)

Additional Information


Skip Object Refresh (FSCCOLD@1.1001:datimpnoobjectrefresh) Permanent link for this heading

Prepares the commit of changes.

boolean FSCCOLD@1.1001:datimpnoobjectrefresh readonly(inst)

Additional Information


Skip Setting Modification Properties (FSCCOLD@1.1001:datimpnoteless) Permanent link for this heading

boolean FSCCOLD@1.1001:datimpnoteless readonly(inst)

Additional Information


Data Source Object (FSCCOLD@1.1001:datimpobjdatasource) Permanent link for this heading

Object FSCCOLD@1.1001:datimpobjdatasource readonly(inst)

Additional Information


Object Relations (FSCCOLD@1.1001:datimpobjectreferences) Permanent link for this heading

The property datimpobjectreferences ("Object Relations") defines the list of references in the table that should be kept. Each list entry consists of an (created or refreshed) object and a target object class and a target property. The object becomes an element of the target list property of the target class.

ObjectReference[] FSCCOLD@1.1001:datimpobjectreferences readonly(inst)

Additional Information


Logging Mode (FSCCOLD@1.1001:datimprecordmode) Permanent link for this heading

The property datimprecordmode ("Logging Mode") defines which information to log for each loader run in the log file.

RecordModeType FSCCOLD@1.1001:datimprecordmode readonly(inst)

Additional Information


Number of Records to Be Read (FSCCOLD@1.1001:datimprecords) Permanent link for this heading

The property datimprecords ("Number of Records to be Read") defines the number of records after which the import process is ended automatically. The value 0 means no limit. The default value is 0.

unsigned integer FSCCOLD@1.1001:datimprecords readonly(inst)

Additional Information


Table (FSCCOLD@1.1001:datimpsourcetable) Permanent link for this heading

The property datimpsourcetable ("Table") defines the name of the table that is imported.

string(4096) FSCCOLD@1.1001:datimpsourcetable readonly(inst)

Additional Information


First Record (FSCCOLD@1.1001:datimpstartrecord) Permanent link for this heading

datimpstartrecord ("First Record") defines the number of the first record to be imported. The import of the database records starts with this record.

unsigned integer FSCCOLD@1.1001:datimpstartrecord readonly(inst)

Additional Information


Abort Data Import Immediately on Error (FSCCOLD@1.1001:datimptermonerror) Permanent link for this heading

boolean FSCCOLD@1.1001:datimptermonerror readonly(inst)

Additional Information


Number of Threads (FSCCOLD@1.1001:datimpthreads) Permanent link for this heading

The property datimpthreads ("Number of Threads") defines the number of threads used by the client for creating objects. The more powerful the system, the more threads can be used. The threads must be coordinated. This results in a certain amount of overhead. Thus large values (] 10) are not useful. The best value should be determined experimental for each case of use. If hash tables are used for creating objects, the number of threads is always set to 1, because hash tables do not allow concurrent inserts. When you create objects having a numerator property you can use only 1 thread.

unsigned integer(3) FSCCOLD@1.1001:datimpthreads readonly(inst)

Additional Information


Activate Logging of Changed Properties (FSCCOLD@1.1001:datimpuiupdate) Permanent link for this heading

The property datimpuiupdate ("Activate Logging of Changed Properties") defines whether or not changes to object properties will be logged in objchangedattributes. As this is a costly operation, it is not recommended to turn it on. If the value is empty, False is used. This option is obsolete, do not use it any more.

boolean FSCCOLD@1.1001:datimpuiupdate readonly(inst)

Additional Information


Use Filter Script for Objects After Commit (FSCCOLD@1.1001:datimpusefiltercommit) Permanent link for this heading

The property datimpusefiltercommit ("Use Filter for Objects After Commit") stores the information whether or not the filter for objects after commit is used. If the value is True, the filter script stored in property DataImportComponentObject::datimpfiltercommit is used.

boolean FSCCOLD@1.1001:datimpusefiltercommit readonly(inst)

Additional Information


Use Filter Script for RAW Data (FSCCOLD@1.1001:datimpusefilterdata) Permanent link for this heading

Defines whether the VB script with the filter action for raw data (property DataImport::datimpfilterdata) is used. True means the filter script is executed for each record.

boolean FSCCOLD@1.1001:datimpusefilterdata readonly(inst)

Additional Information


Use Filter Script for Objects (FSCCOLD@1.1001:datimpusefilterobjects) Permanent link for this heading

Defines whether the VB script with the filter action for raw data (property DataImport::datimpfilterobject) is used. True means the filter script is executed for each handled record.

boolean FSCCOLD@1.1001:datimpusefilterobjects readonly(inst)

Additional Information