2022 June Release

Actions of FSCCOLD@1.1001 Permanent link for this heading

Return Type

Signature

any

AttrConstructorWrapper(
  AttributeDefinition attrdef,
  out retval any value)

void

AttrSetWrapper(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

DefineDataSource(
  optional integer unused1,
  optional integer unused2)

void

DefineDataSourceSelectedObjects(
  optional integer unused1,
  optional integer unused2)

void

ImportData(
  optional boolean vapp,
  optional interface cooparam)

void

ImportDataFinished(
  optional boolean succeeded)

void

ImportDataSelectedObjects(
  optional integer unused1,
  optional integer unused2)

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

ImportRollForwardSelectedObjects(
  optional integer unused1,
  optional integer unused2)

void

ObjectCommittedWrapper()

void

ObjectConstructorWrapper()

void

ObjectFinalizeCommitWrapper()

void

ObjectPrepareCommitWrapper()


FSCCOLD@1.1001:AttrConstructorWrapper Permanent link for this heading

Object::AttrConstructorWrapper ("Dynamic wrapper for "Create property value"") is called as a dynamic wrapper for AttrConstructor (see MAPOPT_SKIPATTRCONSTRUCTOR).

any FSCCOLD@1.1001:AttrConstructorWrapper(
  AttributeDefinition attrdef,
  out retval any value)

Name

Description

attrdef

value

Additional Information


FSCCOLD@1.1001:AttrSetWrapper Permanent link for this heading

Object::AttrSetWrapper ("Dynamic wrapper for "Set property value"") is called as a dynamic wrapper for AttrSet (see MAPOPT_SKIPATTRSET)

void FSCCOLD@1.1001:AttrSetWrapper(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

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:DefineDataSourceSelectedObjects Permanent link for this heading

Object::DefineDataSourceSelectedObjects ("Define Data Sources for Selected Objects") calls the method DataImport::DefineDataSource for all selected objects. It has the hints MH_CHANGESOBJ and MH_NEEDSLOCALGUI assigned.

void FSCCOLD@1.1001:DefineDataSourceSelectedObjects(
  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:ImportDataSelectedObjects Permanent link for this heading

Object::ImportDataSelectedObjects ("Import Data for Selected Objects") calls the method DataImport::ImportData for all selected objects. It has the hints MH_CHANGESOBJ and MH_NEEDSLOCALGUI assigned.

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

Name

Description

unused1

unused2

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


FSCCOLD@1.1001:ImportRollForwardSelectedObjects Permanent link for this heading

Object::ImportRollForwardSelectedObjects ("Roll Forward for Selected Objects") calls the method DataImport::ImportRollForward for all selected objects. It has the hints MH_CHANGESOBJ and MH_NEEDSLOCALGUI assigned.

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

Name

Description

unused1

unused2

Additional Information


FSCCOLD@1.1001:ObjectCommittedWrapper Permanent link for this heading

Object::ObjectCommittedWrapper ("Dynamic wrapper for "Object changes have been committed"") is called as a dynamic wrapper for ObjectCommitted (see CLSOPT_SKIPCOMMITTED)

void FSCCOLD@1.1001:ObjectCommittedWrapper()

Additional Information


FSCCOLD@1.1001:ObjectConstructorWrapper Permanent link for this heading

Object::ObjectConstructorWrapper ("Dynamic wrapper for "Construct object"") is called as a dynamic wrapper for ObjectConstructor (see CLSOPT_SKIPCONSTRUCTOR).

void FSCCOLD@1.1001:ObjectConstructorWrapper()

Additional Information


FSCCOLD@1.1001:ObjectFinalizeCommitWrapper Permanent link for this heading

Object::ObjectFinalizeCommitWrapper ("Dynamic wrapper for "Finalize commit of object changes"") is called as a dynamic wrapper for ObjectFinalizeCommit (see CLSOPT_SKIPFINALIZECOMMIT).

void FSCCOLD@1.1001:ObjectFinalizeCommitWrapper()

Additional Information


FSCCOLD@1.1001:ObjectPrepareCommitWrapper Permanent link for this heading

Object::ObjectPrepareCommitWrapper ("Dynamic wrapper for "Prepare commit of object changes"") is called as a dynamic wrapper for ObjectPrepareCommit (see CLSOPT_SKIPPREPARECOMMIT).

void FSCCOLD@1.1001:ObjectPrepareCommitWrapper()

Additional Information