KB214007: List of custom tests performed by ScanMD

Salesforce Solutions Architect • Strategy

KB214007: List of custom tests performed by ScanMD

SUMMARY

ScanMD is a utility designed to detect and repair known logical inconsistencies in a MicroStrategy metadata. For more information regarding ScanMD, refer to KB483179: Using ScanMD to fix known logical metadata inconsistencies in the MicroStrategy Product Suite 2019 and later.

This technical note lists known logical inconsistencies included in the Custom Tests. The list below consists of what checks are performed for each test, associated technical notes, and applicable versions of this custom test.

NOTE: the content of this tech note is meant for Technical Support only. Should you suspect a customer's issue to be resolved by one of the following custom tests, please speak with APS Client and provide details on the exact issue, a backup of the metadata with the issue, and the custom test you suspect would resolve the problem so APS Client can provide the custom test to you.

LIST OF CUSTOM TESTS

TQMS	Associated TNs	Test Name	Level	Description	Applicable Versions
101217	32036	Check Missing Profile Linkitem	Application	Checks each user profile's folders and match its link item entry in profile link object. If a user profile's 5 folders are valid and its link item entry is missing in profile link object, the fix adds a new link item to re-link the user and the profile folder and grants FullControl on the all the objects inside the profile folder.	Current for 9.x
125749	N/A	Duplicate AttributeInfo in Tables Cleanup	Schema	"Key is not unique in collection" error appears when editing a table if it contains duplicate references to attributes with the same IDs. This fix will remove all duplicate attributes in the Table object definition except for the one which has the most attribute forms in its definition.	Current for 9.x
190192	10036, 13589	User-Everyone group link fix	Application	Re-establish links between users and Everyone group if a user loses its membership to the Everyone gruop and thus is denied access to any project if it attempts to log in	Current for 9.x
230063	N/A	Embedded format name Cleanup	Application	"Object name is too long." error message appears after upgrading to MicroStrategy 8.0.1 due to format names that are longer than 250 characters. This fix will reset those format names to blank if they are longer than 125 characters for reports, documents, templates, and autostyles.	Legacy for 8.x
245175	31941, 42313, 43010, 44392, 44913	Schedules Verification	Configuration	This fix will clean the schedule folder referring to an invalid project, schedule request command statement referencing a report/document or user that no longer exists in the metadata, and invalid linkitems.	Current for 9.x
257931	N/A	Invalid Shortcut Cleanup	Application	This fix will remove any shortcuts that do not have valid targets or have invalid targets pointing to objects that no longer exist in the metadata.	Current for 9.x
281171	N/A	Schema Collection Verification	Schema	This fix adds Attributes, Facts and Tables back to their respective schema object collection.	Custom test obsolete in ScanMD 9.000.001, included in the common tests
307524	N/A	Check MDXHierarchies Levels collections on Catalogs	Schema	This fix will scan the MD for Catalog objects referencing missing column objects and will restore the Levels collections of physical layer MDXHierarchies to a state compatible with the logical layer information, such that cube import/update, edit etc. operations are made possible again.	Current for 9.x
310003	9045, 15750, 18133, 19481, 31663, 33284, 33351, 35168, 36101, 36358, 36987, 37144, 37150, 37340, 37556, 44480, 45330, 47336	Duplicate Columns Cleanup	Schema	There are duplicate Columns in "System Objects/Columns" folder. This Custom Test will merge them to one provided case matches and varies only by a number appended at the end of the column.	Current for 9.x
US3968	N/A	Enhanced Duplicate Columns Cleanup	Schema	This test uses a new rule to determine duplicate candidates. If two columns have names that match String *NAME*, they may be duplicate candidates. All the conditions in KB36352 are not used. So if two candidates have the same column definition name, they will be treated as duplicates.
349210	N/A	Check Invalid Project Reference	Configuration	The Server Definition contains a reference to a project where the Project’s ID is either invalid or NULL. The result can be unexpected behavior in the Desktop GUI such as: A. Encountering the error "Object variable or With block variable not set" when clicking on the 'Administration' icon in MicroStrategy Desktop. B. Receiving the error "Key is not unique in collection" when starting the MicroStrategy Intelligence Server. C. The appearance of multiple Administration icons in MicroStrategy Desktop. This fix will remove the invalid Project reference from Server Definition.	Current for 9.x
357216	43677	Invalid DBRole Reset	Schema	"Object with ID 'XXX' and type 29 (DB Instance) is not found in metadata" prevents Desktop/Developer 9.x from opening up the project's warehouse catalog. This fix will reset the Warehouse Catalog's DBRole to the project's default DBRole. If the project does not have a default DBRole, it will choose the first one from Configuration's "DBRoles" folder. After that, user can manually switch to another DBRole.	Current for 9.x
357866	30475, 35140	System Hierarchy Verification	Schema	Check and remove the invalid reference to missing attribute from System Hierarchy.	Custom test obsolete in ScanMD 9.000.001, included in the common tests
362765	31451, 40605	Check Invalid CurrentElementStatus in Reports and Templates	Application	This function checks whether the page-by axis contains any unit with CurrentElementStatus as "Chosen". The fix will change the CurrentElementStatus from "Chosen" to "Desired".	Current for 9.x
368226	200860	Check Invalid Schema Reference in XDA Reports	Application	Unable to run reports; error of type "Object with ID 'XXX' and type 22 (Schema) is not found in metadata. It may have been deleted." occurs. This error appears while executing a FFSQL report. The test will find out all FFSQL reports (with full path) whose source tables contain invalid references to missing schema objects. This test provides no fix but necessary information and let customers be able to tell which FFSQL Reports are not working before the end users realize it.	Current for 9.x
373433	31538	Check SourceOrder columns corresponding to MDX Schemas	Schema	After Project Duplication or Object Manager move of MDX source related objects, the Source Order attribute form always returns -1, so that it is impossible to sort/arrange the results. This test will scan the MD for MDX-source related SourceOrder column objects and will restore invalid properties of these columns from other information such that the Source Order attribute forms functionality is restored. (No access to the MDX source is needed for this operation.)	Current for 9.x
374107	N/A	Check Invalid Reference to Missing Metric in Report	Application	This test checks whether the report contains invalid reference to missing metrics in the PropertyTarget folder at both report level and template level. The fix will remove the invalid references.	Current for 9.x
382996	N/A	Check Empty Dimty in XDA Metric	Application	This test is to search XDA metrics with empty dimensionality and then put them in report level dimensionality.	Current for 9.x
388194	33587, 34592	Check DBRoles in DSSTable and DSSDBTable	Schema	This test provides ability to clear a DSSTable's Primary and Secondary DBRoles making a table point to the projefct's default database instance	Current for 9.x
400617	34622, 34663, 40522	Check Deep Expression in Consolidation	Application	This test checks all consolidation elements for expressions with more than 200 pairs of nested parentheses. The fix will simplify such expressions by removing those parentheses that are not required to maintain the same order of precedence of the operators in the expression.	Current for 9.x
413387	N/A	Check invalid prompt references in filters	Application	This test provides ability to remove invalid Prompt references in: embedded Filters in Reports, standalone Filters and Custom Groups.	Current for 9.x
431850	N/A	Check invalid names of the reports and filters and their embedded objects	Application	This test checks whether 4 kinds of invalid characters [ ] " \ exist in the object names of Reports and Filters, as well as their embedded Filters, Prompts, and Metrics. The fix will replace invalid characters [ ] " \ with _ _ ' / respectively.	Current for 9.x
456977	N/A	Check Non-Default Web Preference Property Values	Configuration	This test inspects link items used to store Microstrategy Web User Preferences and if any of them is using a non-default value the fix will modify them to use the default value. This test is useful when the following error is observed while logging in from MicroStrategy Web: "String index out of range: 129".	Current for 9.x
477180	N/A	Check invalid custom group references in filters and templates	Application	This fix provides the ability to remove invalid Custom Group references from concrete element nodes in Filters in Report, Document, Filter, Prompt and Metric. Added fix to remove invalid Custom Group reference from concrete and subtotal element nodes in Template.	Current for 9.x
500807	N/A	Invalid Name Conversion	Application	This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check invalid characters like [, ], ", \. And the fix will replace those character with (, ), ', / respectively.	Current for 9.x
733251	N/A	N/A	Application	This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check duplicated embedded IDs in different standalone objects and the fix will change the duplicated ID to a unique one.	Current for 9.x
792455	N/A	Remove Dormant Prompt Instances from Reports	Application	This test scans all Reports to remove any dormant prompt instances. This will prevent the prompt instances from re-occurring when re-prompting.	Current for 9.x
863773	N/A	Check for Invalid Visible Property	Application	This test scans the visible property of panel node and its default formatting in all documents and it will reset the incorrect value for default format and exisitng panel node.	Current for 9.x

Comment

0 comments

Details

Knowledge Article

Published:

July 27, 2023

Last Updated:

January 31, 2024

TQMS	Associated TNs	Test Name	Level	Description	Applicable Versions
101217	32036	Check Missing Profile Linkitem	Application	Checks each user profile's folders and match its link item entry in profile link object. If a user profile's 5 folders are valid and its link item entry is missing in profile link object, the fix adds a new link item to re-link the user and the profile folder and grants FullControl on the all the objects inside the profile folder.	Current for 9.x
125749	N/A	Duplicate AttributeInfo in Tables Cleanup	Schema	"Key is not unique in collection" error appears when editing a table if it contains duplicate references to attributes with the same IDs. This fix will remove all duplicate attributes in the Table object definition except for the one which has the most attribute forms in its definition.	Current for 9.x
190192	10036, 13589	User-Everyone group link fix	Application	Re-establish links between users and Everyone group if a user loses its membership to the Everyone gruop and thus is denied access to any project if it attempts to log in	Current for 9.x
230063	N/A	Embedded format name Cleanup	Application	"Object name is too long." error message appears after upgrading to MicroStrategy 8.0.1 due to format names that are longer than 250 characters. This fix will reset those format names to blank if they are longer than 125 characters for reports, documents, templates, and autostyles.	Legacy for 8.x
245175	31941, 42313, 43010, 44392, 44913	Schedules Verification	Configuration	This fix will clean the schedule folder referring to an invalid project, schedule request command statement referencing a report/document or user that no longer exists in the metadata, and invalid linkitems.	Current for 9.x
257931	N/A	Invalid Shortcut Cleanup	Application	This fix will remove any shortcuts that do not have valid targets or have invalid targets pointing to objects that no longer exist in the metadata.	Current for 9.x
281171	N/A	Schema Collection Verification	Schema	This fix adds Attributes, Facts and Tables back to their respective schema object collection.	Custom test obsolete in ScanMD 9.000.001, included in the common tests
307524	N/A	Check MDXHierarchies Levels collections on Catalogs	Schema	This fix will scan the MD for Catalog objects referencing missing column objects and will restore the Levels collections of physical layer MDXHierarchies to a state compatible with the logical layer information, such that cube import/update, edit etc. operations are made possible again.	Current for 9.x
310003	9045, 15750, 18133, 19481, 31663, 33284, 33351, 35168, 36101, 36358, 36987, 37144, 37150, 37340, 37556, 44480, 45330, 47336	Duplicate Columns Cleanup	Schema	There are duplicate Columns in "System Objects/Columns" folder. This Custom Test will merge them to one provided case matches and varies only by a number appended at the end of the column.	Current for 9.x
US3968	N/A	Enhanced Duplicate Columns Cleanup	Schema	This test uses a new rule to determine duplicate candidates. If two columns have names that match String *NAME*, they may be duplicate candidates. All the conditions in KB36352 are not used. So if two candidates have the same column definition name, they will be treated as duplicates.
349210	N/A	Check Invalid Project Reference	Configuration	The Server Definition contains a reference to a project where the Project’s ID is either invalid or NULL. The result can be unexpected behavior in the Desktop GUI such as: A. Encountering the error "Object variable or With block variable not set" when clicking on the 'Administration' icon in MicroStrategy Desktop. B. Receiving the error "Key is not unique in collection" when starting the MicroStrategy Intelligence Server. C. The appearance of multiple Administration icons in MicroStrategy Desktop. This fix will remove the invalid Project reference from Server Definition.	Current for 9.x
357216	43677	Invalid DBRole Reset	Schema	"Object with ID 'XXX' and type 29 (DB Instance) is not found in metadata" prevents Desktop/Developer 9.x from opening up the project's warehouse catalog. This fix will reset the Warehouse Catalog's DBRole to the project's default DBRole. If the project does not have a default DBRole, it will choose the first one from Configuration's "DBRoles" folder. After that, user can manually switch to another DBRole.	Current for 9.x
357866	30475, 35140	System Hierarchy Verification	Schema	Check and remove the invalid reference to missing attribute from System Hierarchy.	Custom test obsolete in ScanMD 9.000.001, included in the common tests
362765	31451, 40605	Check Invalid CurrentElementStatus in Reports and Templates	Application	This function checks whether the page-by axis contains any unit with CurrentElementStatus as "Chosen". The fix will change the CurrentElementStatus from "Chosen" to "Desired".	Current for 9.x
368226	200860	Check Invalid Schema Reference in XDA Reports	Application	Unable to run reports; error of type "Object with ID 'XXX' and type 22 (Schema) is not found in metadata. It may have been deleted." occurs. This error appears while executing a FFSQL report. The test will find out all FFSQL reports (with full path) whose source tables contain invalid references to missing schema objects. This test provides no fix but necessary information and let customers be able to tell which FFSQL Reports are not working before the end users realize it.	Current for 9.x
373433	31538	Check SourceOrder columns corresponding to MDX Schemas	Schema	After Project Duplication or Object Manager move of MDX source related objects, the Source Order attribute form always returns -1, so that it is impossible to sort/arrange the results. This test will scan the MD for MDX-source related SourceOrder column objects and will restore invalid properties of these columns from other information such that the Source Order attribute forms functionality is restored. (No access to the MDX source is needed for this operation.)	Current for 9.x
374107	N/A	Check Invalid Reference to Missing Metric in Report	Application	This test checks whether the report contains invalid reference to missing metrics in the PropertyTarget folder at both report level and template level. The fix will remove the invalid references.	Current for 9.x
382996	N/A	Check Empty Dimty in XDA Metric	Application	This test is to search XDA metrics with empty dimensionality and then put them in report level dimensionality.	Current for 9.x
388194	33587, 34592	Check DBRoles in DSSTable and DSSDBTable	Schema	This test provides ability to clear a DSSTable's Primary and Secondary DBRoles making a table point to the projefct's default database instance	Current for 9.x
400617	34622, 34663, 40522	Check Deep Expression in Consolidation	Application	This test checks all consolidation elements for expressions with more than 200 pairs of nested parentheses. The fix will simplify such expressions by removing those parentheses that are not required to maintain the same order of precedence of the operators in the expression.	Current for 9.x
413387	N/A	Check invalid prompt references in filters	Application	This test provides ability to remove invalid Prompt references in: embedded Filters in Reports, standalone Filters and Custom Groups.	Current for 9.x
431850	N/A	Check invalid names of the reports and filters and their embedded objects	Application	This test checks whether 4 kinds of invalid characters [ ] " \ exist in the object names of Reports and Filters, as well as their embedded Filters, Prompts, and Metrics. The fix will replace invalid characters [ ] " \ with _ _ ' / respectively.	Current for 9.x
456977	N/A	Check Non-Default Web Preference Property Values	Configuration	This test inspects link items used to store Microstrategy Web User Preferences and if any of them is using a non-default value the fix will modify them to use the default value. This test is useful when the following error is observed while logging in from MicroStrategy Web: "String index out of range: 129".	Current for 9.x
477180	N/A	Check invalid custom group references in filters and templates	Application	This fix provides the ability to remove invalid Custom Group references from concrete element nodes in Filters in Report, Document, Filter, Prompt and Metric. Added fix to remove invalid Custom Group reference from concrete and subtotal element nodes in Template.	Current for 9.x
500807	N/A	Invalid Name Conversion	Application	This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check invalid characters like [, ], ", \. And the fix will replace those character with (, ), ', / respectively.	Current for 9.x
733251	N/A	N/A	Application	This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check duplicated embedded IDs in different standalone objects and the fix will change the duplicated ID to a unique one.	Current for 9.x
792455	N/A	Remove Dormant Prompt Instances from Reports	Application	This test scans all Reports to remove any dormant prompt instances. This will prevent the prompt instances from re-occurring when re-prompting.	Current for 9.x
863773	N/A	Check for Invalid Visible Property	Application	This test scans the visible property of panel node and its default formatting in all documents and it will reset the incorrect value for default format and exisitng panel node.	Current for 9.x

TQMS

Associated TNs

Test Name

Level

Description

Applicable Versions

101217

32036

Check Missing Profile Linkitem

Application

Checks each user profile's folders and match its link item entry in profile link object. If a user profile's 5 folders are valid and its link item entry is missing in profile link object, the fix adds a new link item to re-link the user and the profile folder and grants FullControl on the all the objects inside the profile folder.

Current for 9.x

125749

N/A

Duplicate AttributeInfo in Tables Cleanup

Schema

"Key is not unique in collection" error appears when editing a table if it contains duplicate references to attributes with the same IDs. This fix will remove all duplicate attributes in the Table object definition except for the one which has the most attribute forms in its definition.

Current for 9.x

190192

10036, 13589

User-Everyone group link fix

Application

Re-establish links between users and Everyone group if a user loses its membership to the Everyone gruop and thus is denied access to any project if it attempts to log in

Current for 9.x

230063

N/A

Embedded format name Cleanup

Application

"Object name is too long." error message appears after upgrading to MicroStrategy 8.0.1 due to format names that are longer than 250 characters. This fix will reset those format names to blank if they are longer than 125 characters for reports, documents, templates, and autostyles.

Legacy for 8.x

245175

31941, 42313, 43010, 44392, 44913

Schedules Verification

Configuration

This fix will clean the schedule folder referring to an invalid project, schedule request command statement referencing a report/document or user that no longer exists in the metadata, and invalid linkitems.

Current for 9.x

257931

N/A

Invalid Shortcut Cleanup

Application

This fix will remove any shortcuts that do not have valid targets or have invalid targets pointing to objects that no longer exist in the metadata.

Current for 9.x

281171

N/A

Schema Collection Verification

Schema

This fix adds Attributes, Facts and Tables back to their respective schema object collection.

Custom test obsolete in ScanMD 9.000.001, included in the common tests

307524

N/A

Check MDXHierarchies Levels collections on Catalogs

Schema

This fix will scan the MD for Catalog objects referencing missing column objects and will restore the
Levels collections of physical layer MDXHierarchies to a state compatible
with the logical layer information, such that cube import/update, edit etc.
operations are made possible again.

Current for 9.x

310003

9045, 15750, 18133, 19481, 31663, 33284, 33351, 35168, 36101, 36358, 36987, 37144, 37150, 37340, 37556, 44480, 45330, 47336

Duplicate Columns Cleanup

Schema

There are duplicate Columns in "System Objects/Columns" folder. This Custom Test will merge them to one provided case matches and varies only by a number appended at the end of the column.

Current for 9.x

US3968

N/A

Enhanced Duplicate Columns Cleanup

Schema

This test uses a new rule to determine duplicate candidates. If two columns have names that match String *NAME*, they may be duplicate candidates. All the conditions in KB36352 are not used. So if two candidates have the same column definition name, they will be treated as duplicates.

349210

N/A

Check Invalid Project Reference

Configuration

The Server Definition contains a reference to a project where the Project’s ID is either invalid or NULL. The result can be unexpected behavior in the Desktop GUI such as:
A. Encountering the error "Object variable or With block variable not set" when clicking on the 'Administration' icon in MicroStrategy Desktop.
B. Receiving the error "Key is not unique in collection" when starting the MicroStrategy Intelligence Server.
C. The appearance of multiple Administration icons in MicroStrategy Desktop.
This fix will remove the invalid Project reference from Server Definition.

Current for 9.x

357216

43677

Invalid DBRole Reset

Schema

"Object with ID 'XXX' and type 29 (DB Instance) is not found in metadata" prevents Desktop/Developer 9.x from opening up the project's warehouse catalog. This fix will reset the Warehouse Catalog's DBRole to the project's default DBRole. If the project does not have a default DBRole, it will choose the first one from Configuration's "DBRoles" folder. After that, user can manually switch to another DBRole.

Current for 9.x

357866

30475, 35140

System Hierarchy Verification

Schema

Check and remove the invalid reference to missing attribute from System Hierarchy.

Custom test obsolete in ScanMD 9.000.001, included in the common tests

362765

31451, 40605

Check Invalid CurrentElementStatus in Reports and Templates

Application

This function checks whether the page-by axis contains any unit with CurrentElementStatus as "Chosen". The fix will change the CurrentElementStatus from "Chosen" to "Desired".

Current for 9.x

368226

200860

Check Invalid Schema Reference in XDA Reports

Application

Unable to run reports; error of type "Object with ID 'XXX' and type 22 (Schema) is not found in metadata. It may have been deleted." occurs. This error appears while executing a FFSQL report. The test will find out all FFSQL reports (with full path) whose source tables contain invalid references to missing schema objects. This test provides no fix but necessary information and let customers be able to tell which FFSQL Reports are not working before the end users realize it.

Current for 9.x

373433

31538

Check SourceOrder columns corresponding to MDX Schemas

Schema

After Project Duplication or Object Manager move
of MDX source related objects, the Source Order attribute form always
returns -1, so that it is impossible to sort/arrange the results.
This test will scan the MD for MDX-source related SourceOrder column objects
and will restore invalid properties of these columns from other information
such that the Source Order attribute forms functionality is restored.
(No access to the MDX source is needed for this operation.)

Current for 9.x

374107

N/A

Check Invalid Reference to Missing Metric in Report

Application

This test checks whether the report contains invalid reference to missing metrics in the PropertyTarget folder at both report level and template level. The fix will remove the invalid references.

Current for 9.x

382996

N/A

Check Empty Dimty in XDA Metric

Application

This test is to search XDA metrics with empty dimensionality and then put them in report level dimensionality.

Current for 9.x

388194

33587, 34592

Check DBRoles in DSSTable and DSSDBTable

Schema

This test provides ability to clear a DSSTable's Primary and Secondary DBRoles making a table point to the projefct's default database instance

Current for 9.x

400617

34622, 34663, 40522

Check Deep Expression in Consolidation

Application

This test checks all consolidation elements for expressions with more than 200 pairs of nested parentheses. The fix will simplify such expressions by removing those parentheses that are not required to maintain the same order of precedence of the operators in the expression.

Current for 9.x

413387

N/A

Check invalid prompt references in filters

Application

This test provides ability to remove invalid Prompt references in: embedded Filters in Reports, standalone Filters and Custom Groups.

Current for 9.x

431850

N/A

Check invalid names of the reports and filters and their embedded objects

Application

This test checks whether 4 kinds of invalid characters [ ] " \ exist in the object names of Reports and Filters, as well as their embedded Filters, Prompts, and Metrics. The fix will replace invalid characters [ ] " \ with _ _ ' / respectively.

Current for 9.x

456977

N/A

Check Non-Default Web Preference Property Values

Configuration

This test inspects link items used to store Microstrategy Web User Preferences and if any of them is using a non-default value the fix will modify them to use the default value. This test is useful when the following error is observed while logging in from MicroStrategy Web: "String index out of range: 129".

Current for 9.x

477180

N/A

Check invalid custom group references in filters and templates

Application

This fix provides the ability to remove invalid Custom Group references from concrete element nodes in Filters in Report, Document, Filter, Prompt and Metric. Added fix to remove invalid Custom Group reference from concrete and subtotal element nodes in Template.

Current for 9.x

500807

N/A

Invalid Name Conversion

Application

This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check invalid characters like [, ], ", \. And the fix will replace those character with (, ), ', / respectively.

Current for 9.x

733251

N/A

Application

This test scans all Reports and Filters and the embedded Filter, Prompt, Metric objects inside them to check duplicated embedded IDs in different standalone objects and the fix will change the duplicated ID to a unique one.

Current for 9.x

792455

N/A

Remove Dormant Prompt Instances from Reports

Application

This test scans all Reports to remove any dormant prompt instances. This will prevent the prompt instances from re-occurring when re-prompting.

Current for 9.x

863773

N/A

Check for Invalid Visible Property

Application

This test scans the visible property of panel node and its default formatting in all documents and it will reset the incorrect value for default format and exisitng panel node.

Current for 9.x