Properties of FSCCOLD@1.1001

Type	Property	Name
integer(5)	datimpbulksize	Number of Records for Commit
CheckDuplicates	datimpcheckduplicates	Avoid Duplicate Objects
ClassOption[]	datimpclassoptions	Options
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
History[]	datimphistory	Log
date	datimphistorydateend	End Time
date	datimphistorydatestart	Start Time
integer	datimphistoryerrors	Errors
integer	datimphistoryobjects	Objects Created
content	datimphistoryrecord	Log File
integer	datimphistoryrecords	Records
integer	datimphistoryrefreshed	Objects Refreshed
integer	datimphistorythreads	Threads
DataImportLog	datimplogobj	Log Object
ObjectClass	datimpmapclass	Object Class
string(100)	datimpmapcolumn	Column
boolean	datimpmapcreate	Create Objects
KeyUpdateMode	datimpmapkeyupdate	Key Mode/Update Mode
integer(3)	datimpmapobjectid	Object ID
MappingOption[]	datimpmapoptions	Options
Mapping[]	datimpmapping	Mapping
AttributeDefinition[]	datimpmapproperty	Property
string(100)	datimpmapvalue	Value
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	datimpobj	Data Import
Object	datimpobjdatasource	Data Source Object
ObjectReference[]	datimpobjectreferences	Object Relations
string[]	datimponfinishexpr	Expression on Finish
QueryScope	datimpqueryscope	Query Scope
RecordModeType	datimprecordmode	Logging Mode
integer	datimprecords	Number of Records to Be Read
ObjectClass	datimprefgeneratedclass	Source Object Class
integer(3)	datimprefgeneratedid	Source Object ID
ReferenceOption[]	datimprefoptions	Options
ObjectClass	datimpreftargetclass	Target Object Class
integer(3)	datimpreftargetid	Target Object ID
AttributeDefinition[]	datimpreftargetproperty	Target Property
RefUpdateMode	datimprefupdate	Update Mode
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
content	datimpunfinished	Roll Forward Log
boolean	datimpusefiltercommit	Use Filter Script for Objects After Commit
boolean	datimpusefilterdata	Use Filter Script for RAW Data
boolean	datimpusefilterobjects	Use Filter Script for Objects
DemoDataExpression[]	ddcustomizingexprs	Customizing Expressions
string[]	ddeexpr	Expression
string	ddename	Name
NamedContent[]	ddiadditionalfiles	Additional Files
Content	ddidatasource	Data Source
DataImportComponentObject	ddiimport	Data Import
DemoDataImport[]	ddimports	Data Import
string[]	ddiprepareexpr	Preparation Expression
string(100)	repconvendofline	End of Line
FieldConversion[]	repconvfieldconversion	Field Conversion
integer(7)	repconvfieldheight	Height
string(100)	repconvfieldmark	Characteristic
boolean	repconvfieldmustbedefined	Must Be Defined
string(100)	repconvfieldname	Field Name
integer(5)	repconvfieldoffsetx	Offset Column
integer(5)	repconvfieldoffsety	Offset Line
boolean	repconvfieldsavecontent	Save as Content
string(100)	repconvfieldvalue	Value
integer(5)	repconvfieldwidth	Width
boolean	repconvignorecontrol	Ignore Control Characters
boolean	repconvoemtoansi	OEM to ANSI Conversion
string(100)	repconvpageseparator	Start of Page
PageSeparatorBelongs	repconvpageseparatorbelongs	Page Separator Belongs to
integer(5)	repconvskipcolumns	Skip Leading Columns per Line
integer(5)	repconvskiplines	Skip Leading Lines on Page

Number of Records for Commit (FSCCOLD@1.1001:datimpbulksize)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Avoid Duplicate Objects (FSCCOLD@1.1001:datimpcheckduplicates)

The property datimpcheckduplicates ("Avoid Duplicate Objects") defines the algorithm that is applied for existing objects. You have the possibility to ignore multiple objects, search for each object, or to execute one huge search at the beginning of the import process. The duration of the import process depends on the used algorithm.

CheckDuplicates FSCCOLD@1.1001:datimpcheckduplicates

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Options (FSCCOLD@1.1001:datimpclassoptions)

Defines the class options.

unique ClassOption[] FSCCOLD@1.1001:datimpclassoptions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Class Properties (FSCCOLD@1.1001:datimpclassproperties)

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

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

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Source (FSCCOLD@1.1001:datimpdatasource)

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

Action Called Before Property Is Saved: AttrPrivateSet
Action Called After Property Is Read: AttrPrivateGet
Action to Copy Property From Object: NoOperation
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Source Type (FSCCOLD@1.1001:datimpdatasourcetype)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Skip Methods Without Check (FSCCOLD@1.1001:datimpfastwrapper)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Use All Columns for Filter (FSCCOLD@1.1001:datimpfilterallcolumns)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Script for Objects After Commit (FSCCOLD@1.1001:datimpfiltercommit)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Expression for Objects After Commit (FSCCOLD@1.1001:datimpfiltercommitexpr)

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

Action Called Before Property Is Saved: AttrExprCheckSet
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Script for RAW Data (FSCCOLD@1.1001:datimpfilterdata)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Expression for RAW Data (FSCCOLD@1.1001:datimpfilterdataexpr)

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

Action Called Before Property Is Saved: AttrExprCheckSet
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Script for Objects (FSCCOLD@1.1001:datimpfilterobjects)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Filter Expression for Objects (FSCCOLD@1.1001:datimpfilterobjectsexpr)

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

Action Called Before Property Is Saved: AttrExprCheckSet
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Log (FSCCOLD@1.1001:datimphistory)

The property datimphistory ("Log") contains information about done import processes.

History[] FSCCOLD@1.1001:datimphistory

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

End Time (FSCCOLD@1.1001:datimphistorydateend)

Defines the time the execution of the import process ended.

date FSCCOLD@1.1001:datimphistorydateend local

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Start Time (FSCCOLD@1.1001:datimphistorydatestart)

Defines the time the execution of the import process started.

date FSCCOLD@1.1001:datimphistorydatestart local

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Errors (FSCCOLD@1.1001:datimphistoryerrors)

Defines the number of errors that occurred during the execution of the import process.

unsigned integer FSCCOLD@1.1001:datimphistoryerrors

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Objects Created (FSCCOLD@1.1001:datimphistoryobjects)

Defines the number of objects that were created during the execution of the import process.

unsigned integer FSCCOLD@1.1001:datimphistoryobjects

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Log File (FSCCOLD@1.1001:datimphistoryrecord)

Defines the log file of the import process.

content FSCCOLD@1.1001:datimphistoryrecord

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Records (FSCCOLD@1.1001:datimphistoryrecords)

Defines the number of records that were processed during the execution of the import process.

unsigned integer FSCCOLD@1.1001:datimphistoryrecords

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Objects Refreshed (FSCCOLD@1.1001:datimphistoryrefreshed)

Defines th number of objects that existed and that were updated during the execution of the import process.

unsigned integer FSCCOLD@1.1001:datimphistoryrefreshed

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Threads (FSCCOLD@1.1001:datimphistorythreads)

Defines the number of threads that were used for the import process.

unsigned integer FSCCOLD@1.1001:datimphistorythreads

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Log Object (FSCCOLD@1.1001:datimplogobj)

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

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: DataImportLog
Search for Allowed Classes Only
Action Called Before Property Is Saved: AttrChildrenACLRefSet
Action to Copy Property From Object: NoOperation
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Object Class (FSCCOLD@1.1001:datimpmapclass)

Defines the object class the mapped property (Mapping::datimpmapproperty) belongs to.

ObjectClass FSCCOLD@1.1001:datimpmapclass

Additional Information

Object Classes Allowed: ObjectClass
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Column (FSCCOLD@1.1001:datimpmapcolumn)

Defines the column name of the table or the name of the field of a print file that is mapped to a the property specified with Mapping::datimpmapproperty.

string(100) FSCCOLD@1.1001:datimpmapcolumn

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Create Objects (FSCCOLD@1.1001:datimpmapcreate)

Defines whether to create a new object, if no object exists with this key. This property is used for key properties only. If the value is True, a new object is created, if an object with the key does not exist.

boolean FSCCOLD@1.1001:datimpmapcreate

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Key Mode/Update Mode (FSCCOLD@1.1001:datimpmapkeyupdate)

Defines the key mode and/or the update mode. The value of this property determines whether or not the property is a key property and when the value is set. This property uses property action DataImport::GetCOLDMapping to upgrade Data Import Objects.

KeyUpdateMode FSCCOLD@1.1001:datimpmapkeyupdate

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Object ID (FSCCOLD@1.1001:datimpmapobjectid)

Defines the object ID used to identify an object of a certain object class. This property is only necessary when several objects from one object class should be created from a database record. In this case the property value is used together with the property Mapping::datimpmapclass to distinguish between the objects.

unsigned integer(3) FSCCOLD@1.1001:datimpmapobjectid

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Options (FSCCOLD@1.1001:datimpmapoptions)

Defines the mapping option.

unique MappingOption[] FSCCOLD@1.1001:datimpmapoptions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Mapping (FSCCOLD@1.1001:datimpmapping)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Property (FSCCOLD@1.1001:datimpmapproperty)

Defines the property the column or field is mapped to. The property belongs to the object class specified with the property Mapping::datimpmapclass.

AttributeDefinition[] FSCCOLD@1.1001:datimpmapproperty

Additional Information

Object Classes Allowed: AttributeDefinition
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Value (FSCCOLD@1.1001:datimpmapvalue)

The property datimpmapvalue ("Value") stores a value that is used for the specified property of all created and updated objects In this case the column or field name (Mapping::datimpmapcolumn) is ignored.

string(100) FSCCOLD@1.1001:datimpmapvalue

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Maximum Number of Entries in Log (FSCCOLD@1.1001:datimpmaxhistory)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

At Least (FSCCOLD@1.1001:datimpminbulksize)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Skip Object Refresh (FSCCOLD@1.1001:datimpnoobjectrefresh)

Prepares the commit of changes.

boolean FSCCOLD@1.1001:datimpnoobjectrefresh readonly(inst)

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Skip Setting Modification Properties (FSCCOLD@1.1001:datimpnoteless)

boolean FSCCOLD@1.1001:datimpnoteless readonly(inst)

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Import (FSCCOLD@1.1001:datimpobj)

Object FSCCOLD@1.1001:datimpobj not null

Additional Information

Object Classes Allowed: DataImport, DataImportComponentObject
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Source Object (FSCCOLD@1.1001:datimpobjdatasource)

Object FSCCOLD@1.1001:datimpobjdatasource readonly(inst)

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: ContentObject, ComponentContentObject
Search for Allowed Classes Only
Action to Copy Property From Object: NoOperation
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Object Relations (FSCCOLD@1.1001:datimpobjectreferences)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Expression on Finish (FSCCOLD@1.1001:datimponfinishexpr)

::cooparam (COMINTERFACE, usually a DICTIONARY): Parameter object (see ImportRemote).
::cooimport (OBJECT): Import control object (see DataImportControl).
::records (INTEGER): Number of records.
::created (INTEGER): Number of new objects.
::refreshed (INTEGER): Number of refreshed objects.
::errors (INTEGER): Number of errors.

string[] FSCCOLD@1.1001:datimponfinishexpr readonly(inst)(
  interface ::cooparam,
  DataImportControl ::cooimport,
  integer ::records,
  integer ::created,
  integer ::refreshed,
  integer ::errors)

Local Scope: dictionary
Global Scope: dictionary

Name	Description
::cooparam
::cooimport
::records
::created
::refreshed
::errors

Additional Information

Action Called Before Property Is Saved: AttrExprCheckSet
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Query Scope (FSCCOLD@1.1001:datimpqueryscope)

The Query Scope is used for searching for objects of the particular class. If undefined only objects of the current domain will be found.

QueryScope FSCCOLD@1.1001:datimpqueryscope

Additional Information

Object Classes Allowed: QueryScope
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Logging Mode (FSCCOLD@1.1001:datimprecordmode)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Number of Records to Be Read (FSCCOLD@1.1001:datimprecords)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Source Object Class (FSCCOLD@1.1001:datimprefgeneratedclass)

Defines the source object class. An object of this class is stored in an object list property of an object of the target class, if a record describes objects of these two classes.

ObjectClass FSCCOLD@1.1001:datimprefgeneratedclass

Additional Information

Object Classes Allowed: ObjectClass
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Source Object ID (FSCCOLD@1.1001:datimprefgeneratedid)

Defines the ID of the source object.

unsigned integer(3) FSCCOLD@1.1001:datimprefgeneratedid

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Options (FSCCOLD@1.1001:datimprefoptions)

Defines the reference options.

unique ReferenceOption[] FSCCOLD@1.1001:datimprefoptions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Target Object Class (FSCCOLD@1.1001:datimpreftargetclass)

Defines the target object class. An object of this class stores an object of the target class in an object list property, if a record describes objects of these two classes.

ObjectClass FSCCOLD@1.1001:datimpreftargetclass

Additional Information

Object Classes Allowed: ObjectClass
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Target Object ID (FSCCOLD@1.1001:datimpreftargetid)

Defines the ID of the target object.

unsigned integer(3) FSCCOLD@1.1001:datimpreftargetid

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Target Property (FSCCOLD@1.1001:datimpreftargetproperty)

Defines the target property. An object of the source class is stored in this property of an object of the target class, if a record describes objects of these two classes.

AttributeDefinition[] FSCCOLD@1.1001:datimpreftargetproperty

Additional Information

Object Classes Allowed: AttributeDefinition
Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Update Mode (FSCCOLD@1.1001:datimprefupdate)

Defines the update mode. The value of this property determines when and how the property will be updated.

RefUpdateMode FSCCOLD@1.1001:datimprefupdate

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Table (FSCCOLD@1.1001:datimpsourcetable)

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

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

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

First Record (FSCCOLD@1.1001:datimpstartrecord)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Abort Data Import Immediately on Error (FSCCOLD@1.1001:datimptermonerror)

boolean FSCCOLD@1.1001:datimptermonerror readonly(inst)

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Number of Threads (FSCCOLD@1.1001:datimpthreads)

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

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Activate Logging of Changed Properties (FSCCOLD@1.1001:datimpuiupdate)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Roll Forward Log (FSCCOLD@1.1001:datimpunfinished)

Defines the roll forward log of the last loader run in CSV format.

content FSCCOLD@1.1001:datimpunfinished

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Use Filter Script for Objects After Commit (FSCCOLD@1.1001:datimpusefiltercommit)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Use Filter Script for RAW Data (FSCCOLD@1.1001:datimpusefilterdata)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Use Filter Script for Objects (FSCCOLD@1.1001:datimpusefilterobjects)

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

Obsolete
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Customizing Expressions (FSCCOLD@1.1001:ddcustomizingexprs)

DemoDataExpression[] FSCCOLD@1.1001:ddcustomizingexprs

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Expression (FSCCOLD@1.1001:ddeexpr)

string[] FSCCOLD@1.1001:ddeexpr not null

Local Scope: object

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Name (FSCCOLD@1.1001:ddename)

string FSCCOLD@1.1001:ddename

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Additional Files (FSCCOLD@1.1001:ddiadditionalfiles)

unique NamedContent[] FSCCOLD@1.1001:ddiadditionalfiles

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Source (FSCCOLD@1.1001:ddidatasource)

Content FSCCOLD@1.1001:ddidatasource not null

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Import (FSCCOLD@1.1001:ddiimport)

DataImportComponentObject FSCCOLD@1.1001:ddiimport not null

Additional Information

Search for Allowed Classes Only
ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Data Import (FSCCOLD@1.1001:ddimports)

DemoDataImport[] FSCCOLD@1.1001:ddimports

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Preparation Expression (FSCCOLD@1.1001:ddiprepareexpr)

string[] FSCCOLD@1.1001:ddiprepareexpr

Local Scope: object

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

End of Line (FSCCOLD@1.1001:repconvendofline)

The property repconvendofline ("End of Line") defines the mark that determines the end of the line. The following table shows the codes that may be used and the characters they represent.

string(100) FSCCOLD@1.1001:repconvendofline

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Field Conversion (FSCCOLD@1.1001:repconvfieldconversion)

The property repconvfieldconversion ("Field Conversion") defines the list of fields of a document of a print file. Each list entry consists of the field name, the identification, line offset, the height, the column offset, the width, and the information whether the field is a content property.

FieldConversion[] FSCCOLD@1.1001:repconvfieldconversion not null

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Height (FSCCOLD@1.1001:repconvfieldheight)

The property repconvfieldheight ("Height") defines the number of lines the field covers.
Set repconvfieldheight to -1 to get all remaining lines until the end of the page. The default value is 1.

integer(7) FSCCOLD@1.1001:repconvfieldheight

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Characteristic (FSCCOLD@1.1001:repconvfieldmark)

The property repconvfieldmark ("Characteristic") defines the identification for the field. The further values for the definition of the fields position are relative to this identification. A field identification is optional.

string(100) FSCCOLD@1.1001:repconvfieldmark

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Must Be Defined (FSCCOLD@1.1001:repconvfieldmustbedefined)

The property repconvfieldmustbedefined ("Must be Defined?") defines whether the field must have a value or not. True means that the field must have a value.

boolean FSCCOLD@1.1001:repconvfieldmustbedefined

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Field Name (FSCCOLD@1.1001:repconvfieldname)

The property repconvfieldname ("Field Name") defines the name of the field that is used as the column name in the data import object.

string(100) FSCCOLD@1.1001:repconvfieldname

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Offset Column (FSCCOLD@1.1001:repconvfieldoffsetx)

The property repconvfieldoffsetx ("Offset Column") defines the column (x position) of the fields start position. The default value is the left margin of the document. If the fields identification is specified (property FieldConversion::repconvfieldmark) the fields start position is relative to the position of the mark. In this case the default value is the first character after the identification.

integer(5) FSCCOLD@1.1001:repconvfieldoffsetx

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Offset Line (FSCCOLD@1.1001:repconvfieldoffsety)

The property repconvfieldoffsety ("Offset Line") defines the line (y position) of the fields start position. The default value is the beginning of the document. If the fields identification is specified (property FieldConversion::repconvfieldmark) the fields start position is relative to the position of the mark. In this case the default value is the line in which the identification is located.

integer(5) FSCCOLD@1.1001:repconvfieldoffsety

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Save as Content (FSCCOLD@1.1001:repconvfieldsavecontent)

The property repconvfieldsavecontent ("Save as Content?") defines whether the field content will be assigned to a content property.
When repconvfieldsavecontent is set to yes the content of the field is saved to a temporary file, which can be directly assigned to content properties. When repconvfieldsavecontent is set to no the content of the field is kept in memory.

boolean FSCCOLD@1.1001:repconvfieldsavecontent

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Value (FSCCOLD@1.1001:repconvfieldvalue)

The property repconvfieldvalue ("Value") defines a fixed value used for this field during the load process. Use this function e.g. if you want to use always the same value for a certain field or if you want to append a fixed value to the field.

string(100) FSCCOLD@1.1001:repconvfieldvalue

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Width (FSCCOLD@1.1001:repconvfieldwidth)

The property repconvfieldwidth ("Width") defines the number of columns the field covers. The default value is 1.

unsigned integer(5) FSCCOLD@1.1001:repconvfieldwidth

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Ignore Control Characters (FSCCOLD@1.1001:repconvignorecontrol)

The property repconvignorecontrol ("Ignore Control Characters") defines whether control characters are ignored or not. If the property has the value True, the control characters in the print file are ignored.

boolean FSCCOLD@1.1001:repconvignorecontrol

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

OEM to ANSI Conversion (FSCCOLD@1.1001:repconvoemtoansi)

The property repconvoemtoansi ("OEM to ANSI Conversion") defines whether the conversion from OEM to ANSI should be done or not. If the value is True, the conversion is done.

boolean FSCCOLD@1.1001:repconvoemtoansi

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Start of Page (FSCCOLD@1.1001:repconvpageseparator)

The property repconvpageseparator ("Start of Page") defines the string that indicates the beginning of a new document in a print file. The following table shows the codes that may be used and the characters they represent.

string(100) FSCCOLD@1.1001:repconvpageseparator

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Page Separator Belongs to (FSCCOLD@1.1001:repconvpageseparatorbelongs)

The property repconvpageseparatorbelongs ("Page Separator Belongs to") defines to which document the page separator belongs to. The page separator may be the end of the read document, the start of the new document, or belong to none of the documents.

PageSeparatorBelongs FSCCOLD@1.1001:repconvpageseparatorbelongs not null

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Skip Leading Columns per Line (FSCCOLD@1.1001:repconvskipcolumns)

The property repconvskipcolumns ("Skip Leading Columns per Line") defines the number of leading columns that are ignored for each line of a document.

unsigned integer(5) FSCCOLD@1.1001:repconvskipcolumns

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001

Skip Leading Lines on Page (FSCCOLD@1.1001:repconvskiplines)

The property repconvskiplines ("Skip Leading Lines on Page") defines the number of lines that are ignored for each document of the print file.

unsigned integer(5) FSCCOLD@1.1001:repconvskiplines

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCCOLD@1.1001