Namespace: Consultingwerk.SmartFramework.Repository
Class 
SmartRepositoryIntegrityCheckTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.OERA.BusinessEntityBusinessTask
Consultingwerk.SmartFramework.Repository.SmartRepositoryIntegrityCheckTask

Inherits: Consultingwerk.OERA.BusinessEntityBusinessTask
Implements: Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, IProvidesBusinessEntityDescriptor, Consultingwerk.OERA.ISupportsResetState, ISupportsRestMethods


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
CheckCrossContainerReferences () Checks the references of links and object instances to instances and pages of other containers
CheckCustomizedInstances () Checks the object instances of the customized variants against the instances of their base object master
CheckCustomizedObjectMasters () Checks the customized variants of the object masters
CheckCustomizedPages () Checks the pages of the customized variants for collisions with the pages of their base object master
CheckDesignTimeDataSources () Checks the DesignTimeDataSource table for orphan records
CheckSmartAttribute () Checks SmartAttribute for orphan records
CheckSmartAttributeValue () Checks SmartAttributeValue for orphan records
CheckSmartCustomization () Checks SmartCustomization for orphan records
CheckSmartEntityTableMapping () Checks SmartEntityTableMapping for orphan records
CheckSmartLink () Checks SmartLink for orphan records
CheckSmartModule () Checks SmartModule for orphan records
CheckSmartObjectInstance () Checks SmartObjectInstance for orphan records
CheckSmartObjectMaster () Checks SmartObjectMaster for orphan records
CheckSmartObjectType () Checks SmartObjectType for orphan records
CheckSmartPage () Checks SmartPage for orphan records
CheckSmartSupportedInstanceObjectType () Checks SmartSupportedLink for orphan records
CheckSmartSupportedLink () Checks SmartSupportedLink for orphan records
CollectCustomizedVariants () Collects the customized variants of the repository and their base object masters into the ttCustomizedVariant temp-table
INT64 CountResultRecords (ICountRecordsRequest) Counts the number of results of the repository integrity check
DeleteOrphanRecord (dataset-handle, IntegrityCheckParameter) Deletes an orphan record
DeleteOrphanRecord (IntegrityCheckParameter) Deletes an orphan record
CHARACTER DescribeMissingBaseReference (character) Returns the description of an orphan reference of a container to an object instance or page
DocumentOrphanRecord (character, character, character, character, character, character) Documents orphan records by writing them to ttOrphanedRecords
DocumentOrphanRecord (character, character, character, character, character, character, character) Documents a finding by writing it to ttOrphanedRecords
FetchData (IFetchDataRequest) Fetch data and/or definitions
CHARACTER GetCustomizationResultCode (character) Returns the customization result code of an object master
CHARACTER GetMessageText (integer, character, character) Returns the text of a message of the SFR message group
CHARACTER GetMessageText (integer, character, character, character) Returns the text of a message of the SFR message group
CHARACTER GetMessageText (integer, character, character, character, character) Returns the text of a message of the SFR message group
CHARACTER GetMessageText (integer, character, character, character, character, character) Returns the text of a message of the SFR message group
CHARACTER GetObjectMasterName (character) Returns the name of an object master
LOGICAL IsAcceptedContainerReference (character, character) Returns if a reference of a container to a record of another container is accepted
LOGICAL IsLikelyOrphanedCustomizedInstance (buffer, character, character) Returns if an instance of a customized variant without a base instance of the same name is probably the customized (shadow) instance of a renamed or removed base instance
PerformIntegrityCheck (dataset, ISerializable) Executes all methods of the SmartRepositoryIntegrityCheckTask
SaveChanges (Object) Saves changes

Top Constructor Summary
Options Name Purpose
SmartRepositoryIntegrityCheckTask () Constructor for the SmartRepositoryIntegrityCheckTask class


Method Detail
Top

CheckCrossContainerReferences ()
Purpose: Checks the references of links and object instances to instances
and pages of other containers
Notes: SCL-5903: The source and target instances of a link, the parent
instance and the page of an object instance belong to the
container of the link or instance. The only accepted exception
are the references of a customized variant to the instances and
pages of its base object master. References to records that do
not exist are reported as orphan records by CheckSmartLink and
CheckSmartObjectInstance

Top

CheckCustomizedInstances ()
Purpose: Checks the object instances of the customized variants against
the instances of their base object master
Notes: SCL-5903: A customized (shadow) instance is matched to its base
instance by name. An instance of a variant with the name of a
base instance but a different object master is suspicious (the
base received an instance with the name of an instance added by
the variant), an attribute-only instance of a variant without a
base instance of the same name but with a base instance at the
same position is probably the customized instance of a renamed
base instance. SCL-6021: Without such a base instance it is a
legitimate addition of the variant and not reported

Top

CheckCustomizedObjectMasters ()
Purpose: Checks the customized variants of the object masters
Notes: SCL-5903: Cross-container references that are not the references
of a variant to its base object master, page number and page key
collisions between a base and its variants, instances of a
variant with the name of a base instance but another object
master (suspicious customized instances) and instances of a
variant that are probably the customized instances of renamed
base instances. The variants without base are reported by
CheckSmartObjectMaster

Top

CheckCustomizedPages ()
Purpose: Checks the pages of the customized variants for collisions with
the pages of their base object master
Notes: SCL-5903: The page numbers and page keys are unique across a base
object master and its variants (validated by the
ObjectMasterBusinessEntity). A collision arises when the base
receives a page after the variant was created (upgrade case)

Top

CheckDesignTimeDataSources ()
Purpose: Checks the DesignTimeDataSource table for orphan records
Notes:

Top

CheckSmartAttribute ()
Purpose: Checks SmartAttribute for orphan records
Notes: Parent: SmartAttributeGroup

Top

CheckSmartAttributeValue ()
Purpose: Checks SmartAttributeValue for orphan records
Notes: Parents: SmartAttribute, SmartObjectInstance, SmartObjectMaster, SmartObjectType

Top

CheckSmartCustomization ()
Purpose: Checks SmartCustomization for orphan records
Notes: Parents: SmartCustomizationResult, SmartCustomizationType

Top

CheckSmartEntityTableMapping ()
Purpose: Checks SmartEntityTableMapping for orphan records
Notes: Parent: SmartObjectMaster

Top

CheckSmartLink ()
Purpose: Checks SmartLink for orphan records
Notes: Parents: SmartObjectMaster, SmartObjectInstance (has 2 related fields)

Top

CheckSmartModule ()
Purpose: Checks SmartModule for orphan records
Notes: Parent: SmartProduct

Top

CheckSmartObjectInstance ()
Purpose: Checks SmartObjectInstance for orphan records
Notes: Parent: SmartPage

Top

CheckSmartObjectMaster ()
Purpose: Checks SmartObjectMaster for orphan records
Notes: Parent: SmartCustomizationResult, SmartObjectType, SmartModule, SmartObjectInstance
SCL-5897: A customized object master (CustomizationResultGuid not empty)
requires a base object master of the same ObjectName (SCL-5903:
reported with the description SFR:46)

Top

CheckSmartObjectType ()
Purpose: Checks SmartObjectType for orphan records
Notes: Parent: SmartClassType

Top

CheckSmartPage ()
Purpose: Checks SmartPage for orphan records
Notes: Parent: SmartObjectMaster

Top

CheckSmartSupportedInstanceObjectType ()
Purpose: Checks SmartSupportedLink for orphan records
Notes:

Top

CheckSmartSupportedLink ()
Purpose: Checks SmartSupportedLink for orphan records
Notes:

Top

CollectCustomizedVariants ()
Purpose: Collects the customized variants of the repository and their
base object masters into the ttCustomizedVariant temp-table
Notes: SCL-5903: A customized variant shares the ObjectName of its base
object master (CustomizationResultGuid = ""). The
BaseObjectMasterGuid is unknown for a variant without base

Top

INT64 CountResultRecords (ICountRecordsRequest)
Purpose: Counts the number of results of the repository integrity check
Notes: Executes FetchData to populate the dataset and then counts all ttOrphanedRecords

Parameters:
poParameter Consultingwerk.OERA.ICountRecordsRequest
The ICountRecordsRequest instance to receive the record count
Returns INT64
The number of orphaned records
Top

DeleteOrphanRecord (dataset-handle, IntegrityCheckParameter)
Purpose: Deletes an orphan record
Notes: Overload with dataset-handle parameter for generic service invocation

Parameters:
phDataset DATASET-HANDLE
The dataset handle (not used)
poParameter Consultingwerk.SmartFramework.Repository.IntegrityCheckParameter
Orphan record to be deleted
Top

DeleteOrphanRecord (IntegrityCheckParameter)
Purpose: Deletes an orphan record
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.IntegrityCheckParameter
orphan record to be deleted
Top

CHARACTER DescribeMissingBaseReference (character)
Purpose: Returns the description of an orphan reference of a container to
an object instance or page
Notes: SCL-5903: The links, parent instances and pages of a customized
variant may refer to the instances and pages of its base object
master. When the referenced record does not exist, the base has
probably been changed after the variant was created. Returns an
empty string when the container is not a customized variant

Parameters:
pcContainerObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container holding the reference
Returns CHARACTER
The description of the finding or an empty string
Top

DocumentOrphanRecord (character, character, character, character, character, character)
Purpose: Documents orphan records by writing them to ttOrphanedRecords
Notes:

Parameters:
pcDatabaseTableName CHARACTER
Name of child table
pcDatabaseFieldName CHARACTER
Name of record in child table
pcRecordKeyValue CHARACTER
GUID record
pcRecordDescription CHARACTER
Meaningful field of the record
pcMissingTableName CHARACTER
Name of parent table
pcMissingKeyValue CHARACTER
Name of index table
Top

DocumentOrphanRecord (character, character, character, character, character, character, character)
Purpose: Documents a finding by writing it to ttOrphanedRecords
Notes: SCL-5903: The CheckDescription describes findings that are not
plain orphan records

Parameters:
pcDatabaseTableName CHARACTER
Name of child table
pcDatabaseFieldName CHARACTER
Name of record in child table
pcRecordKeyValue CHARACTER
GUID record
pcRecordDescription CHARACTER
Meaningful field of the record
pcMissingTableName CHARACTER
Name of parent table
pcMissingKeyValue CHARACTER
Name of index table
pcCheckDescription CHARACTER
The description of the finding, empty for orphan records
Top

FetchData (IFetchDataRequest)
Purpose: Fetch data and/or definitions
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameter for this call
Top

CHARACTER GetCustomizationResultCode (character)
Purpose: Returns the customization result code of an object master
Notes: SCL-5903: Returns an empty string for a base object master and for
a customization result that does not exist

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the object master
Returns CHARACTER
The customization result code
Top

CHARACTER GetMessageText (integer, character, character)
Purpose: Returns the text of a message of the SFR message group
Notes: SCL-5903: The descriptions of the customization findings are
registered in the SmartFramework Message Dictionary

Parameters:
piMessageNumber INTEGER
The message number
pcParameter1 CHARACTER
The first message parameter
pcParameter2 CHARACTER
The second message parameter
Returns CHARACTER
The message text
Top

CHARACTER GetMessageText (integer, character, character, character)
Purpose: Returns the text of a message of the SFR message group
Notes: SCL-5903: The descriptions of the customization findings are
registered in the SmartFramework Message Dictionary

Parameters:
piMessageNumber INTEGER
The message number
pcParameter1 CHARACTER
The first message parameter
pcParameter2 CHARACTER
The second message parameter
pcParameter3 CHARACTER
The third message parameter
Returns CHARACTER
The message text
Top

CHARACTER GetMessageText (integer, character, character, character, character)
Purpose: Returns the text of a message of the SFR message group
Notes: SCL-5903: The descriptions of the customization findings are
registered in the SmartFramework Message Dictionary

Parameters:
piMessageNumber INTEGER
The message number
pcParameter1 CHARACTER
The first message parameter
pcParameter2 CHARACTER
The second message parameter
pcParameter3 CHARACTER
The third message parameter
pcParameter4 CHARACTER
The fourth message parameter
Returns CHARACTER
The message text
Top

CHARACTER GetMessageText (integer, character, character, character, character, character)
Purpose: Returns the text of a message of the SFR message group
Notes: SCL-5903: The descriptions of the customization findings are
registered in the SmartFramework Message Dictionary

Parameters:
piMessageNumber INTEGER
The message number
pcParameter1 CHARACTER
The first message parameter
pcParameter2 CHARACTER
The second message parameter
pcParameter3 CHARACTER
The third message parameter
pcParameter4 CHARACTER
The fourth message parameter
pcParameter5 CHARACTER
The fifth message parameter
Returns CHARACTER
The message text
Top

CHARACTER GetObjectMasterName (character)
Purpose: Returns the name of an object master
Notes: SCL-5903: Returns the ObjectMasterGuid when the object master does
not exist

Parameters:
pcObjectMasterGuid CHARACTER
The ObjectMasterGuid of the object master
Returns CHARACTER
The name of the object master
Top

LOGICAL IsAcceptedContainerReference (character, character)
Purpose: Returns if a reference of a container to a record of another
container is accepted
Notes: SCL-5903: The references of a customized variant to the instances
and pages of its base object master are the only accepted
cross-container references

Parameters:
pcContainerObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container holding the reference
pcReferencedContainerObjectMasterGuid CHARACTER
The ObjectMasterGuid of the container of the referenced record
Returns LOGICAL
Logical value indicating if the reference is accepted
Top

LOGICAL IsLikelyOrphanedCustomizedInstance (buffer, character, character)
Purpose: Returns if an instance of a customized variant without a base
instance of the same name is probably the customized (shadow)
instance of a renamed or removed base instance
Notes: SCL-5903: A customized instance contributes attribute values
only, is placed like its base instance (page and parent instance
of the base object master or none) and is never referenced by
the links and instances of the variant. An instance placed on a
page of the variant or below an instance of the variant is an
addition of the variant. When the base object master has an
instance at the same position (object master, page, parent
instance and object sequence), the base instance has probably
been renamed without the rename cascading to the customized
instance and its name is returned

Parameters:
b_Instance buffer
The buffer positioned on the instance of the variant
pcBaseObjectMasterGuid CHARACTER
The ObjectMasterGuid of the base object master
pcRenamedBaseInstanceName CHARACTER
OUTPUT The name of the base instance at the same position, empty when there is none
Returns LOGICAL
Logical value indicating if the instance is probably an orphaned customized instance
Top

PerformIntegrityCheck (dataset, ISerializable)
Purpose: Executes all methods of the SmartRepositoryIntegrityCheckTask
Notes:

Parameters:
dsOrphanedRecords DATASET dsOrphanedRecords
INPUT-OUTPUT Dataset used for passing the data
poParameter Consultingwerk.ISerializable
The reference to the parameter object instance returned by the task
Top

SaveChanges (Object)
Purpose: Saves changes
Notes: This method is called from consumers of the Business Task and
receives the dataset.

Parameters:
poParameter Progress.Lang.Object
Optional Parameter object for the SaveChanges method


Constructor Detail
Top

SmartRepositoryIntegrityCheckTask ()
Purpose: Constructor for the SmartRepositoryIntegrityCheckTask class
Notes:



ProDataset Detail

ProDataset dsOrphanedRecords

Member tables: ttOrphanedRecords


Temp-Table Detail

Temp-Table ttOrphanedRecords

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:30:58