Object Class Data Import Control (FSCCOLD@1.1001:DataImportControl)

Object Class Hierarchy

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

Use an object of class DataImportControl ("Data Import Control") to override executions options of a FSCCOLD@1.1001:DataImportComponentObject. A FSCCOLD@1.1001:DataImportComponentObject is provided by a software component that can be only configured by an administrator. You can use this object to let the end user override options needed for loader execution (i.e. using a specific data source file). Options not specified by the FSCCOLD@1.1001:DataImportControl use the corresponding option in the referenced FSCCOLD@1.1001:DataImportComponentObject.

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Default Context Menu (Container Independent): COODESK@1.1:MenuRootOLEContext
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
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
Display Mode: DISP_LINES
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
FSCCOLD@1.1001:datimpbulksizeNumber of Records for Commit
FSCCOLD@1.1001:datimpdatasourceData Source
FSCCOLD@1.1001:datimpdatasourcetypeData Source
FSCCOLD@1.1001:datimplogobjLog Object
FSCCOLD@1.1001:datimpmaxhistoryMaximum Number of Entries in Log
FSCCOLD@1.1001:datimpminbulksizeAt Least
FSCCOLD@1.1001:datimpnoobjectrefreshSkip Object Refresh
FSCCOLD@1.1001:datimpobjData Import
FSCCOLD@1.1001:datimpobjdatasourceData Source Object
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

Actions

ReferenceName
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: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: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: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:datimpobj (Data Import)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: true
Possible Object Class: COOSYSTEM@1.1:Object
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[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: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]

Actions

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]