Strategy ONE
Executing a Test from the Command Line
Integrity Manager's command line interface enables you to execute a test without having to load the graphical interface, or to schedule a test to run at specific times or dates. For example, you perform routine maintenance on your data warehouse every month. Using the Windows AT command or the UNIX scheduler, you can schedule a baseline-versus-project test to run every month immediately after routine database maintenance. This ensures that no reports are broken during maintenance.
If you are running Integrity Manager in a Windows environment, you must be logged in to Windows with an Administrator account. In addition, if you are running Integrity Manager directly from the command prompt, you must set the command prompt to run with full administrative privileges. To do this, right-click on the command prompt shortcut and select Run As. Clear the Run this program with restricted access check box and click OK.
To Execute a Previously Saved Integrity Test from the Command Line
After creating and saving a test (for instructions, see Saving and Loading a Test), call the Integrity Manager executable MIntMgr.exe with the parameters listed in the table below. All parameters are optional except the -f parameter, which specifies the integrity test file path and name.
By default, the executable is installed in the following directory:
C:\Program Files (x86)\MicroStrategy\Integrity Manager
|
Effect |
Parameters |
|
Integrity test file path and name |
|
|
Base system password. For instructions on how to specify multiple passwords, or passwords using special characters, see Password Syntax. |
|
|
Target system password. For instructions on how to specify multiple passwords, or passwords using special characters, see Password Syntax. |
|
|
The following parameters modify the execution of the test. They do not modify the .mtc test file. |
|
|
Output directory. This directory must exist before the test can be executed. |
|
|
Log file path and name. |
|
|
Base server name. |
|
|
Target server name. |
|
|
Base server port number. |
|
|
Target server port number. |
|
|
Base project. |
|
|
Target project. |
|
|
Login for base project. For multiple logins, enclose all logins in double quotes (") and separate each login with a comma (,). |
-blogin " |
|
Login for target project. For multiple logins, enclose all logins in double quotes (") and separate each login with a comma (,) |
-tlogin " |
|
Base baseline file path and name. The GUIDs of objects to be tested in the baseline file must match any GUIDs specified in the .mtc file. |
-bbaselinefile |
|
Target baseline file path and name. The GUIDs of objects to be tested in the baseline file must match any GUIDs specified in the .mtc file. |
-tbaselinefile |
|
Whether to use load balancing in the base project, that is, whether to execute the reports and documents across all nodes of the cluster ( If this option is used, it overrides the setting in the integrity test file. |
- -bloadbalance false |
|
Whether to use load balancing in the target project, that is, whether to execute the reports and documents across all nodes of the cluster ( If this option is used, it overrides the setting in the integrity test file. |
- -tloadbalance false |
|
GUID of the test folder. If this option is used, the reports and documents specified in the integrity test file are ignored. Instead, Integrity Manager executes all reports and documents in the specified folder. This option can only be used with a single-project integrity test or a project-versus-project integrity test. |
|
Password Syntax
When specifying passwords with special characters, or specifying multiple passwords, use the following syntax:
- If a password contains a single quote (') or a comma (,), that character must be preceded by a single quote.
- If a password contains a double quote (") that character must be substituted by ". If a password contains an ampersand (&) that character must be substituted by &.
- For example, if the password is
12'&ABC"12,3then the password must be specified as12''&ABC"12',3. - If multiple logins are used, a password must be specified for each login. The entire list of passwords must be enclosed in double quotes (") and the passwords must be separated by a comma (,).
- If multiple passwords are used and a user in the base project or target project has an empty password, the position of that user's password in the list of passwords is indicated by a space between commas.
For example, if the users for an integrity test are User1, User2, and User3, and User2 has an empty password, the list of passwords is
"password1, ,password3".
Command Line Exit Codes
When an integrity test that has been executed from the command line ends, it returns a number. This number is an exit code. If the script ends unexpectedly, this exit code can help you find the cause of the error.
To view the error code, in the same command prompt window as the test execution, type echo %ERRORLEVEL% and press Enter.
|
Exit code |
Meaning |
|
0 |
The test execution succeeded and all reports have a status of Matched. |
|
1 |
The test execution succeeded, but at least one report has a status other than Matched. |
|
2 |
Integrity Manager was unable to establish a connection to Intelligence Server, or the connection was interrupted during the test. |
|
3 |
Either your Integrity Manager license has expired, or you do not have the privileges necessary to run Integrity Manager. You can view license information in License Manager. |
|
4 |
The test execution failed. For more information about this error, see the integrity test log for this test. |
|
5 |
The test execution was aborted by the user. |
Manually Editing an Integrity Test
If you need to make minor changes to an integrity test, it may be faster to make those changes by editing the test file, rather than stepping through the Integrity Manager Wizard.
The test file is a plain-text XML file, and can be edited in a text editor, such as Notepad. For an explanation of all the XML tags included in the test file, see List of Tags in the Integrity Test File.
