Object Class Data Import (FSCCOLD@1.1001:DataImport)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:BasicObject > FSCCOLD@1.1001:DataImport

Use an object of class DataImport ("Data Import") to control the generic loader. You can specify the data source, the created object classes, the used properties, and the references between the objects. Furthermore you can influence the speed of the import process.

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultAdministratorACL
Symbol: COODESK@1.1:SymbolDataImport
Commonly usable: true
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOSYSTEM@1.1:BasicObject
Action for Linking Objects: COODESK@1.1:DragIntoLink
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Display Mode: DISP_LINES
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
FSCCOLD@1.1001:datimpbulksizeNumber of Records for Commit
FSCCOLD@1.1001:datimpclasspropertiesClass Properties
FSCCOLD@1.1001:datimpdatasourceData Source
FSCCOLD@1.1001:datimpdatasourcetypeData Source
FSCCOLD@1.1001:datimpfastwrapperSkip Methods Without Check
FSCCOLD@1.1001:datimpfilterallcolumnsUse All Columns for Filter
FSCCOLD@1.1001:datimpfiltercommitFilter Script for Objects After Commit
FSCCOLD@1.1001:datimpfiltercommitexprFilter Expression for Objects After Commit
FSCCOLD@1.1001:datimpfilterdataFilter Script for RAW Data
FSCCOLD@1.1001:datimpfilterdataexprFilter Expression for RAW Data
FSCCOLD@1.1001:datimpfilterobjectsFilter Script for Objects
FSCCOLD@1.1001:datimpfilterobjectsexprFilter Expression for Objects
FSCCOLD@1.1001:datimplogobjLog Object
FSCCOLD@1.1001:datimpmappingMapping
FSCCOLD@1.1001:datimpmaxhistoryMaximum Number of Entries in Log
FSCCOLD@1.1001:datimpminbulksizeAt Least
FSCCOLD@1.1001:datimpnoobjectrefreshSkip Object Refresh
FSCCOLD@1.1001:datimpnotelessSkip Setting Modification Properties
FSCCOLD@1.1001:datimpobjdatasourceData Source Object
FSCCOLD@1.1001:datimpobjectreferencesObject Relations
FSCCOLD@1.1001:datimprecordmodeLogging Mode
FSCCOLD@1.1001:datimprecordsNumber of Records to Be Read
FSCCOLD@1.1001:datimpsourcetableTable
FSCCOLD@1.1001:datimpstartrecordFirst Record
FSCCOLD@1.1001:datimptermonerrorAbort Data Import Immediately on Error
FSCCOLD@1.1001:datimpthreadsNumber of Threads
FSCCOLD@1.1001:datimpuiupdateActivate Logging of Changed Properties
FSCCOLD@1.1001:datimpusefiltercommitUse Filter Script for Objects After Commit
FSCCOLD@1.1001:datimpusefilterdataUse Filter Script for RAW Data
FSCCOLD@1.1001:datimpusefilterobjectsUse Filter Script for Objects

Actions

ReferenceName
FSCCOLD@1.1001:DefineDataSource
FSCCOLD@1.1001:ImportData
FSCCOLD@1.1001:ImportDataFinished
FSCCOLD@1.1001:ImportRemote
FSCCOLD@1.1001:ImportRollForward
FSCVCOLD@1.1001:CancelOperation
FSCVCOLD@1.1001:InitializeObject

Properties

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

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.

Additional Information

Changeable in Installed Component: false
Initialization Value: 150
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:INTEGER
Maximum Length: 5
Changeable: true
Must Be Defined: false
Sign: false
Visible: true


[top]

FSCCOLD@1.1001:datimpclassproperties (Class Properties)

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

Additional Information

Type: FSCCOLD@1.1001:ClassProperties
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpdatasource (Data Source)

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.

Additional Information

Changeable in Installed Component: false
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrPrivateSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRING
Action Called After Property Is Read: COOSYSTEM@1.1:AttrPrivateGet
Maximum Length: 254
Action Called After Property of Version Is Read: COOSYSTEM@1.1:AttrGetVersionUsingAttrGet
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

FSCCOLD@1.1001:datimpdatasourcetype (Data Source)

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

Additional Information

Initialization Value: 7
Type: FSCCOLD@1.1001:DataSourceType
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpfastwrapper (Skip Methods Without Check)

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.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

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

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

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

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

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 Components Objects ' tx [IN] Components 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)

Additional Information

Type: COOSYSTEM@1.1:CONTENT
Changeable: true
File Extension: txt
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

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

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 FSCCOLD@1.1001: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 COOSYSTEM@1.1:ObjectClass).
  • ::ids (INTEGERLIST): Object class id's (see FSCCOLD@1.1001:datimpmapobjectid).
  • ::objects (OBJECTLIST): Objects.
  • ::inittx (COMINTERFACE): Main transaction of the data import (equal to cootx in the filter for raw data).

Additional Information

Changeable in Installed Component: false
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

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

The property datimpfilterdata ("Filter Script for Raw Data") stores 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)

Additional Information

Type: COOSYSTEM@1.1:CONTENT
Changeable: true
File Extension: txt
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

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

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 FSCCOLD@1.1001: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.

Additional Information

Changeable in Installed Component: false
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

FSCCOLD@1.1001:datimpfilterobjects (Filter Script for Objects)

The property datimpfilterobjects ("Filter Script for Objects") stores 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 Components Objects ' tx [IN] Components 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)

Additional Information

Type: COOSYSTEM@1.1:CONTENT
Changeable: true
File Extension: txt
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpfilterobjectsexpr (Filter Expression for Objects)

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 FSCCOLD@1.1001: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 COOSYSTEM@1.1:ObjectClass).
  • ::ids (INTEGERLIST): Object class id's (see FSCCOLD@1.1001: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).

Additional Information

Changeable in Installed Component: false
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

FSCCOLD@1.1001:datimplogobj (Log Object)

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.

Additional Information

Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadComp
Changeable in Installed Component: false
Destructor Action: COOSYSTEM@1.1:AttrChildrenDestructor
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrChildrenACLRefSet
Describes Child Relationship: true
Type: COOSYSTEM@1.1:OBJECT
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Possible Object Class: FSCCOLD@1.1001:DataImportLog
Search for Allowed Classes Only: true
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeComp
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true
Action Called Before Property of Version Is Saved: COOSYSTEM@1.1:AttrChildrenFixManualVersion


[top]

FSCCOLD@1.1001:datimpmapping (Mapping)

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

Additional Information

Type: FSCCOLD@1.1001:Mapping
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

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

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.

Additional Information

Sign: false
Type: COOSYSTEM@1.1:INTEGER
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 10
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpminbulksize (At Least)

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.

Additional Information

Sign: false
Type: COOSYSTEM@1.1:INTEGER
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 5
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpnoobjectrefresh (Skip Object Refresh)

Prepares the commit of changes.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpnoteless (Skip Setting Modification Properties)

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpobjdatasource (Data Source Object)

Additional Information

Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadComp
Changeable in Installed Component: false
Describes Child Relationship: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:Object
Search for Allowed Classes Only: true
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeComp
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true
Action Called Before Property of Version Is Saved: COOSYSTEM@1.1:AttrChildrenFixManualVersion


[top]

FSCCOLD@1.1001:datimpobjectreferences (Object Relations)

The property datimpobjectreferences ("Object Relations") defines the list of references in the table that should be kept in Fabasoft Components. 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.

Additional Information

Type: FSCCOLD@1.1001:ObjectReference
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimprecordmode (Logging Mode)

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

Additional Information

Initialization Value: 10
Type: FSCCOLD@1.1001:RecordModeType
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

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

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.

Additional Information

Sign: false
Type: COOSYSTEM@1.1:INTEGER
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 10
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpsourcetable (Table)

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

Additional Information

Type: COOSYSTEM@1.1:STRING
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 4096
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpstartrecord (First Record)

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

Additional Information

Changeable in Installed Component: false
Initialization Value: 1
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:INTEGER
Maximum Length: 10
Changeable: true
Must Be Defined: false
Sign: false
Visible: true


[top]

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

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

FSCCOLD@1.1001:datimpthreads (Number of Threads)

The property datimpthreads ("Number of Threads") defines the number of threads used by the client for creating objects. The more powerful the computer with Fabasoft Components client installed 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.

Additional Information

Changeable in Installed Component: false
Initialization Value: 1
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:INTEGER
Maximum Length: 3
Changeable: true
Must Be Defined: false
Sign: false
Visible: true


[top]

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

The property datimpuiupdate ("Activate Logging of Changed Properties") defines whether or not changes to object properties will be logged in COOEVENT@1.1: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.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

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

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.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

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

The property datimpusefilterdata ("Use Filter for Raw Data") stores the information 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.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

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

The property datimpusefilterobjects ("Use Filter for Objects") stores the information 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.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: false


[top]

Actions

FSCCOLD@1.1001:DefineDataSource

DataImport::DefineDataSource ("Define Data Source") defines data source, table and columns for the data import object.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCOLD@1.1001:ImportData

DataImport::ImportData ("Import Data") starts the generic loader and imports that data according to the definitions in the data import object. During the process the status dialog is displayed. The user can cancel the process with the Stop button. If no data source is defined, all available data sources are listed and the selected one is stored in the data import object. If no table is defined, all available tables are listed and the selected one is stored in the data import object. If the data import object contains no mapping information, the columns of the table are displayed and the selected ones are stored in the data import object. The generic loader sets the transaction variable TV_BATCHMODE of software component System. If this variable is set, overwritten object constructors cannot start user interactions. This is important e.g. for software components that want to start the Property Editor right after the creation of an object.
ParameterTypeIn/OutOptionalDescription
vappCOOSYSTEM@1.1:BOOLEANintrue
cooparamCOOSYSTEM@1.1:COMINTERFACEintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCOLD@1.1001:ImportDataFinished

ParameterTypeIn/OutOptionalDescription
succeededCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCOLD@1.1001:ImportRemote

DataImport::ImportRemote ("Remote-Controlled Import") starts the generic loader and imports that data according to the definitions in the data import object. Use this method from your application. The parameters can be used to influence the user interface. During the process the status dialog is displayed. The user can cancel the process with the Stop button. When more than 1000 errors occurred, the process is also canceled. If no data source is defined, all available data sources are listed and the selected one is stored in the data import object. If no table is defined, all available tables are listed and the selected one is stored in the data import object. If the data import object contains no mapping information, the columns of the table are displayed and the selected ones are stored in the data import object. The generic loader sets the transaction variable TV_BATCHMODE of the software component System. If this variable is set, overwritten object constructors cannot start user interactions. This is important e.g. for software components that want to start the Property Editor right after the creation of an object.
ParameterTypeIn/OutOptionalDescription
showdialogCOOSYSTEM@1.1:BOOLEANintrue Optional. If the value is True, the status dialog is shown. If the value is False, no status dialog is shown. The default value ist True.
closedialogCOOSYSTEM@1.1:BOOLEANintrue Optional. If the value is True, the status dialog is ended after the import process automatically. If the value is False, the user has to end the dialog. The default value ist True.
reportcreatedobjectsCOOSYSTEM@1.1:BOOLEANintrue Optional. If the value is True, the last parameter returns the list of created objects. It is recommended to set this parameter to True only when less then 10000 objects are created.
createdobjectsCOOSYSTEM@1.1:OBJECTLISToutfalse Optional. The list of created objects, if the parameter reportcreatedobjects has is True.
rollforwardCOOSYSTEM@1.1:BOOLEANintrue Optional. Must be set when the roll forward log should be evaluated instead of importing the specified database.
asyncCOOSYSTEM@1.1:BOOLEANintrue
cooparamCOOSYSTEM@1.1:COMINTERFACEintrue
finishedscriptCOOSYSTEM@1.1:CONTENTintrue Script which is called when the import has finished.
synchobjCOOSYSTEM@1.1:COMINTERFACEouttrue
tableCOOSYSTEM@1.1:STRINGintrue
finishedexprCOOSYSTEM@1.1:STRINGLISTintrue Expression which is called when the import has finished (see FSCCOLD@1.1001:datimponfinishexpr).

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCOLD@1.1001:ImportRollForward

DataImport::ImportRollForward ("Roll Forward") loads the data that could not be loaded during the last import process. In principle this action does the same as the action DataImport::ImportData. However it does not read the data from the database but from the property DataImportLog::datimpunfinished.
ParameterTypeIn/OutOptionalDescription
vappCOOSYSTEM@1.1:BOOLEANintrue
cooparamCOOSYSTEM@1.1:COMINTERFACEintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVCOLD@1.1001:CancelOperation

Cancels the COLD job. Calling this action will not immediately cancel the loading process, but only set the attribute FSCVCOLD@1.1001:cancel to true.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVCOLD@1.1001:InitializeObject

Initializes the VAPP extensions of the COLD object. This call must be made before calling any other methods for FSCVCOLD or FSCCOLD when using the Webbrowser client.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]