2022 June Release

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

Return Type

Signature

void

CancelOperation()

void

DefineDataSource(
  optional integer unused1,
  optional integer unused2)

void

ImportData(
  optional boolean vapp,
  optional interface cooparam)

void

ImportDataFinished(
  optional boolean succeeded)

void

ImportRemote(
  optional boolean showdialog,
  optional boolean closedialog,
  optional boolean reportcreatedobjects,
  out object[] createdobjects,
  optional boolean rollforward,
  optional boolean async,
  optional interface cooparam,
  optional content finishedscript,
  out optional interface synchobj,
  optional string table,
  optional string[] finishedexpr)

void

ImportRollForward(
  optional boolean vapp,
  optional interface cooparam)

void

InitializeObject()


FSCVCOLD@1.1001:CancelOperation Permanent link for this heading

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

void FSCVCOLD@1.1001:CancelOperation()

Additional Information


FSCCOLD@1.1001:DefineDataSource Permanent link for this heading

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

void FSCCOLD@1.1001:DefineDataSource(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCCOLD@1.1001:ImportData Permanent link for this heading

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.

void FSCCOLD@1.1001:ImportData(
  optional boolean vapp,
  optional interface cooparam)

Name

Description

vapp

cooparam

Additional Information


FSCCOLD@1.1001:ImportDataFinished Permanent link for this heading

void FSCCOLD@1.1001:ImportDataFinished(
  optional boolean succeeded)

Name

Description

succeeded

Additional Information


FSCCOLD@1.1001:ImportRemote Permanent link for this heading

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.

void FSCCOLD@1.1001:ImportRemote(
  optional boolean showdialog,
  optional boolean closedialog,
  optional boolean reportcreatedobjects,
  out object[] createdobjects,
  optional boolean rollforward,
  optional boolean async,
  optional interface cooparam,
  optional content finishedscript,
  out optional interface synchobj,
  optional string table,
  optional string[] finishedexpr)

Name

Description

showdialog

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.

closedialog

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.

reportcreatedobjects

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.

createdobjects

Optional. The list of created objects, if the parameter reportcreatedobjects has is True.

rollforward

Optional. Must be set when the roll forward log should be evaluated instead of importing the specified database.

async

cooparam

finishedscript

Script which is called when the import has finished.

synchobj

table

finishedexpr

Expression which is called when the import has finished (see datimponfinishexpr).

Additional Information


FSCCOLD@1.1001:ImportRollForward Permanent link for this heading

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.

void FSCCOLD@1.1001:ImportRollForward(
  optional boolean vapp,
  optional interface cooparam)

Name

Description

vapp

cooparam

Additional Information


FSCVCOLD@1.1001:InitializeObject Permanent link for this heading

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.

void FSCVCOLD@1.1001:InitializeObject()

Additional Information