MicroStrategy ONE

Manually Editing an Integrity Test File

If you need to make minor changes to an integrity test, it may be faster to make those changes by manually editing the test file, rather than stepping through the Integrity Manager Wizard.

The MTC test file is a plain-text XML file. You can edit it in any text editor, such as Notepad. The tables below list all the XML tags in an integrity test file, with an explanation of each tag.

XML tags Function
Execution_Mode Type of integrity test, as displayed in the ResultsSummary file:
  • Project versus Project Integrity Test

  • Baseline versus Project Integrity Test

  • Baseline versus Baseline Integrity Test

  • Single Project Integrity Test

This value is for display and localization purposes only.

Execution_Mode_Value Type of integrity test, as executed by Integrity Manager:
LocalVersion Version of Integrity Manager that created the test.
isMultiUser Whether this integrity test supports multiple logins:
  • true: This integrity test supports multiple logins.

  • false: This integrity test does not support multiple logins.

Base_Connection_Index Which ConnectionIndex (0 or 1) indicates the base connection. The other ConnectionIndex is the target connection.

Information in the tags listed in the table below is obtained from the Enter Base Project Information page, Select Baseline page, Enter Target Project Information page, or Select Target page.

Except in a single-project integrity test, this section is repeated for the base connection and the target connection.

XML tags Function
ConnectionIndex= 0 or 1, depending on the value of Base_Connection_Index and whether the information below is for the base or target connection.
Server_Name Name or IP address of the Intelligence Server.
Port Port number of the Intelligence Server.
Authentication_Mode Login authentication mode corresponding to the Login tag below. If isMultiUser is set to true, there can be multiple Authentication_Mode and Login tag pairs.
  • 1: Standard

  • 2: Windows

  • 16: LDAP

  • 32: Database

Login Login ID corresponding to the Authentication_Mode tag above. If isMultiUser is set to true, there can be multiple Authentication_Mode and Login tag pairs.
Project Name of the project.
Project_DssID GUID of the project.
Version The version of Intelligence Server that hosts the project.
Use_Load_Balancing Whether to use load balancing across the cluster for this connection, that is, whether to execute the reports/documents across all nodes of the cluster or on a single node:
  • true: Use load balancing

  • false: Do not use load balancing

baselineConnection Whether this connection uses a baseline file:
  • true: This connection uses a baseline.

  • false: This connection uses a live Intelligence Server.

baselineFile The full path to the baseline file, if baselineConnection is set to true.

Information in the tags listed in the table below is obtained from the Select Objects from the Base Project page, Select Objects to Test page, or Select Target Objects and Map them to Base Objects page.

These tags must be present for each object included in the integrity test.

Object to be tested XML tags Function
Type Type of object to be processed by Integrity Manager:
  • 3: Report

  • 8: Folder

  • 18: Shortcut

  • 39: Search object

  • 55: Document

GUID GUID of the object.
Name Name of the object.
Path Path to the object within the project.
Rounds (This entry is deprecated.)
Reporttype Object type.

If Type is set to 3:

  • 768: Grid view report

  • 769: Graph view report

  • 770: SQL view report

  • 774: Grid/Graph view report

  • 776: Intelligent Cube

  • 778: Transaction

  • 4096: Datamart report

If Type is set to 55:

  • 14081: Report services document

chaseSearches Whether embedded search objects are processed by the integrity test:
  • true: Process embedded search objects.

  • false: Do not process embedded search objects.

objMatchType Whether to match objects by ID or path name:
  • 0: Match by ID.

  • 1: Match by path name.

Use_Obj_Match Whether object matching is used. This is only available for Project to Project tests:
  • true: Object matching is used. This allows you to select which object from the base project is compared to which object from the target project.

  • false: Object matching is not used.

Obj_Match_Map

Only displays if Use_Obj_Match is true. Inside the map is one or more Entry statements which each contain a Key/Value pair for a mapped object, where:

  • Key is the GUID of the object in the base project.

  • Value is the GUID of the object in the target project.

Information in the tags listed in the table below is obtained from the Select Prompt Settings page, the Customize Value Prompt Answers dialog box, and the Advanced Prompt Options dialog box.

Prompt settings XML tags Function
textAnswer Custom answer for text prompts. To provide multiple custom answers for text prompts, include each answer in a separate textAnswer node.
textAnswerIsNull Whether custom answers are provided for text prompts:
  • true: Custom answers are not provided for text prompts.

  • false: Custom answers are provided for text prompts.

numberAnswer Custom answer for numeric or Big Decimal prompts. To provide multiple custom answers for these prompts, include each answer in a separate numberAnswer node.
numberAnswerIsNull Whether custom answers are provided for numeric or Big Decimal prompts:
  • true: Custom answers are not provided for numeric or Big Decimal prompts.

  • false: Custom answers are provided for numeric or Big Decimal prompts.

dateAnswer Custom answer for date prompts. To provide multiple custom answers for date prompts, include each answer in a separate dateAnswer node.
dateAnswerIsNull Whether custom answers are provided for date prompts:
  • true: Custom answers are not provided for date prompts.

  • false: Custom answers are provided for date prompts.

numberElementHierPrompt Number of elements that Integrity Manager selects to answer element hierarchy prompts.
numberElementHierPromptIsNull Whether a custom value is provided for the number of elements used to answer element hierarchy prompts:
  • true: A custom value is not provided for element hierarchy prompts.

  • false: A custom value is provided for element hierarchy prompts.

answerOptionalPrompt Whether optional prompts are answered in this integrity test:
  • true: Optional and required prompts are answered.

  • false: Only required prompts are answered.

PromptAnswerSource The prompt answer sources to be used by this integrity test, in the order that they are to be used, separated by commas. Negative numbers indicate that this answer source is disabled.

All four prompt answer sources must be included in this parameter.

  • 1: Personal answer

  • -1: Personal answer (disabled)

  • 2: Default object answers

  • -2: Default object answers (disabled)

  • 3: Integrity Manager user-defined answer

  • -3: Integrity Manager user-defined answer (disabled)

  • 4: Integrity Manager internal answer

  • -4: Integrity Manager internal answer (disabled)

PromptAnswerSource_VAL A prompt answer source to be used by this integrity test. If multiple prompt answer sources are specified, each must have its own PromptAnswerSource_VAL entry, in the order that they are to be used. Values include:
  • Personal answer

  • Default object answers

  • Integrity Manager user-defined answer

  • Integrity Manager internal answer

isLinkPopup Whether to open reports with unanswered prompts in MicroStrategy Web:
  • true: Open reports with unanswered prompts in MicroStrategy Web.

  • false: Do not execute reports with unanswered prompts.

BaseURL If isLinkPopup is set to true, the URL for the MicroStrategy Web server for the base project.
TargetURL If isLinkPopup is set to true, the URL for the MicroStrategy Web server for the target project.
Personal_Answer_Option

Whether to use only default personal prompt answers, or group personal prompt answers by their names:

  • USE_DEFAULT: Use only default personal prompt answers for each prompt.

  • GROUP_BY_NAME: Group personal prompt answers by their names.

Personal_Answer_Option_Desc

If Personal_Answer_Option is set to USE_DEFAULT, this must be set to Use only default personal prompt answer for each prompt.

If Personal_Answer_Option is set to GROUP_BY_NAME, this must be set to Group personal prompt answers by their names.

Information in the tags listed in the table below is obtained from the Select Execution Settings page.

Execution settings XML tags Function
MaxTimeout Maximum time, in minutes, that a report can run before Integrity Manager cancels it.
numSimultaneousExecutions Maximum number of simultaneous report/document executions during the integrity test.
useCache Whether to use the cached version of an object, if one is available:
  • true: Use the cache

  • false: Do not use the cache; execute each object against the Intelligence Server.

Output_Directory Full path to the location where the integrity test results are saved.
isAppendDateToOutputDir Whether to store the test results in a subdirectory of the Output_Directory, named by date and time of the integrity test execution:
  • true: Store results in a time-stamped subdirectory of the specified directory.

  • false: Store results in the specified directory.

LogLevel Enable or disable logging:
  • 1: Logging is enabled.

  • -5: Logging is disabled.

LogFile Full path to the log file.

Information in the tags listed in the table below is obtained from the Select Processing Options page.

Processing options XML tags Function
isDataEnabled Whether to enable data comparison for reports:
  • true: Enabled.

  • false: Disabled.

isSQLEnabled Whether to enable SQL comparison for reports:
  • true: Enabled.

  • false: Disabled.

isGraphEnabled Whether to enable graph comparison for reports:
  • true: Enabled.

  • false: Disabled.

isExcelEnabled Whether to enable Excel comparison for reports:
  • true: Enabled.

  • false: Disabled.

isPdfEnabled Whether to enable PDF comparison for reports:
  • true: Enabled.

  • false: Disabled.

isRsdExcelEnabled Whether to enable Excel comparison for documents:
  • true: Enabled.

  • false: Disabled.

isRsdPdfEnabled Whether to enable PDF comparison for documents:
  • true: Enabled.

  • false: Disabled.

isRsdExecEnabled Whether to enable execution for documents:
  • true: Enabled.

  • false: Disabled.

reportCycles Number of performance test cycles to run for each report.
documentCycles Number of performance test cycles to run for each document.

Information in the tags listed in the table below is obtained from the SQL/MDX tab of the Advanced Options dialog box.

SQL processing options XML tags Function
isColorCodeSQL Whether to save the generated SQL to an HTML file with differences highlighted in red:
  • true: Enabled.

  • false: Disabled.

dynamicSQLStart Text marking the beginning of any dynamic SQL.
dynamicSQLEnd Text marking the end of any dynamic SQL.
from SQL to be replaced by the SQL indicated by the to tag.
to SQL to replace the SQL indicated by the from tag.
applyTo Where to apply the SQL replacement:
  • 1: Base only

  • 2: Target only

  • 3: Base and target

Information in the tags listed in the table below is obtained from the Data tab of the Advanced Options dialog box.

Data processing options XML tags Function
isCSVEnabled Whether to save the data for each report as a CSV file:
  • true: Enabled.

  • false: Disabled.

Information in the tags listed in the table below is obtained from the Excel tab of the Advanced Options dialog box.

For all Excel processing options, if the option is left blank, the setting for that option is imported from the user’s MicroStrategy Web export preferences, as per the Use Default option in the Integrity Manager Wizard.

Excel processing options XML tags Function
isXLSEnabled Whether to save data for each report as an XLS file.
  • true: Enabled.

  • false: Disabled.

ExportReportTitle Whether to include the report title in the Excel chart:
  • 0: Do not export the report title.

  • -1: Export the report title.

ExportPageByInfo Whether to include which report objects are grouped in a page-by selection in the Excel chart:
  • 0: Do not export the page-by information.

  • -1: Export the page-by information.

isExportFilterDetails Whether to include the report filter details in the Excel chart:
  • true: Export the filter details.

  • false: Do not export the filter details.

isRemoveColumn Whether to remove the extra “Metrics” column from the Excel chart.
  • 0: Remove the extra column.

  • 1: Do not remove the extra column.

  • 2: Use the default setting in the MicroStrategy Web preferences.

ExpandAllPages Whether to include all report objects in the Excel chart, or only objects in the default page-by selection:
  • 0: Export only the default page-by.

  • -1: Export all objects.

excelVersion Excel version of the exported file:
  • 1: Excel 2000

  • 2: Excel XP/2003

  • 4: Excel 2007 or newer

isExportMetricAsText Whether to export metric values as text or as numeric values:
  • true: Export metrics as text.

  • false: Export metrics as numeric values.

isExportHeaderAsText Whether to export data header values as text or as numeric values:
  • true: Export headers as text.

  • false: Export headers as numeric values.

isSeparateSheets Whether to export each page of the report to a separate sheet in the Excel file:
  • true: Export each page as a separate sheet.

  • false: Export the entire report on a single sheet.

isLiveCharts Whether to export graphs in the report as “live” Excel graphs, or as static images:
  • true: Export graphs as live Excel graphs.

  • false: Export graphs as a static image in the Results folder.

ExcelEmbedImages Whether images and graphs in the report can be accessed from the Excel spreadsheet without having to run MicroStrategy Web:
  • 0: Images are not embedded in the spreadsheet.

  • -1: Images are embedded in the spreadsheet.

isOfficeRefresh Whether MicroStrategy Office can refresh reports after they have been exported to Excel.
  • true: Reports can be refreshed from Office.

  • false: Reports are static and cannot be refreshed from Office.

ExcelReportHeader Text of the custom header added to the Excel spreadsheet.
ExcelReportHeaderLocation Where to place the custom header in the Excel export:
  • 0: Display the custom header before other report headers.

  • 1: Display the custom header after other report headers.

  • 2: The custom header replaces any other report headers.

ExcelReportFooter Text of the custom footer added to the Excel spreadsheet.

Information in the tags listed in the table below is obtained from the PDF tab of the Advanced Options dialog box.

For all PDF processing options, if the option is left blank or not listed in the MTC file, that option is processed using the default setting in Intelligence Server’s PDF generation options.

PDF processing options XML tags Function
Scaling Whether to adjust the font to fit the report to a certain percentage of the PDF page (ScalePercentage), or to fit a certain number of report pages on the page (ScalePagesWide and ScalePagesTall):
  • 0: Use ScalePercentage

  • 1: Use ScalePagesWide and ScalePagesTall

ScalePercentage Percentage to scale the font if Scaling is set to 0.
ScalePagesWide Number of report pages per PDF page width, if Scaling is set to 1.
ScalePagesTall Number of report pages per PDF page height, if Scaling is set to 1.
GridandGraph Whether to print the report’s grid and graph on the same page:
  • 0: Print the grid and graph on separate PDF pages.

  • 1: Print the grid and graph on the same PDF page.

Orientation Page orientation:
  • 0: Portrait

  • 1: Landscape

PrintCoverDetails Whether to include a cover page:
  • 0: Do not print a cover page.

  • 1: Print a cover page.

CoverPageDetailsContents What to include in the cover page, if PrintCoverDetails is set to 1:
  • 0: Report filter details

  • 1: Report details

CoverPageLocation Where to include the cover page, if PrintCoverDetails is set to 1:
  • 0: After the report

  • 1: Before the report

ExpandAllPages Whether to include all report objects in the PDF, or only objects in the default page-by selection:
  • 0: Export only the default page-by.

  • 1: Export all objects.

PaperType Paper size of the PDF:
  • 0: Letter (8.5”x11”)

  • 1: Legal (8.5”x14”)

  • 2: Executive (7.25”x10.5”)

  • 3: Folio (8.5”x13”)

  • 4: A3 (11.69”x16.54”)

  • 5: A4 (8.27”x11.69”)

  • 6: A5 (5.83”x8.27”)

MarginLeft Left margin, in inches.
MarginRight Right margin, in inches.
MarginTop Top margin, in inches.
MarginBottom Bottom margin, in inches.
MaxHeaderSize Maximum header size, in inches.
MaxFooterSize Maximum footer size, in inches.
GraphFormat Whether to use bitmaps for graphs:
  • 10: Use bitmaps for graphs.

  • 11: Do not use bitmaps for graphs.

PrintQuality Whether to use draft quality bitmaps for graphs, if GraphFormat is set to 11:
  • 96: Use Draft quality bitmaps.

  • 288: Use Fine quality bitmaps.

EmbedFonts Whether to embed fonts in the PDF:
  • 0: Do not embed fonts.

  • 1: Embed fonts.

HeaderLeft Left page header.
HeaderCenter Center page header.
HeaderRight Right page header.
FooterLeft Left page footer.
FooterCenter Center page footer.
FooterRight Right page footer.
ReportHeader Report header.

Information in the tags listed in the table below is obtained from the Performance tab of the Advanced Options dialog box.

Performance processing options XML tags Function
inclErrorRptInPerformance Whether to include in the performance test the execution times from reports/documents that do not complete execution:
  • true: Include the execution times from all reports/documents.

  • false: Include only the execution times from reports/documents that execute successfully.

Related Topics

Executing a Saved Test from the Command Line

Saving a Test

Using the Integrity Manager Wizard