|
|
Appendix G: QPR Transfertool Command Line Parameters |
|
|
|
||
Appendix G: QPR Transfertool Command Line Parameters |
|
|
|
|
|
|
Appendix G: QPR Transfertool Command Line Parameters |
|
|
|
||
Appendix G: QPR Transfertool Command Line Parameters |
|
|
|
|
|
|
||
This chapter describes some of the command line parameters for the QPR Transfertool database operations.
Note: QPR database versions earlier than 8.0 are not supported.
Do not use these operations unless you know what you are doing.
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Create Database
By starting QPR Transfertool with the /CREATE_DB parameter it is possible to create a new database. Note that a database must already exist as this command will only create the QPR table structure into the database, i.e. it cannot create a completely new database from scratch.
Note that it is possible to overwrite an existing database using this parameter!
Parameters
/dt:<DB> |
Target database name. |
/dt_user:<username> |
Target database username. |
/dt_pwd:<user's password> |
Target database password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
/NOCONFIRM |
Do not ask for confirmations. |
/DEBUG:<location and name name of log file> |
Write a debug log file to the specified location. |
/SILENT |
No UI is shown. When using this parameter, /NOCONFIRM is not needed. |
Example
QPR.TransferTool.exe /CREATE_DB /dt:QPR_2017-1_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt /NOCONFIRM
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Export File
By starting QPR Transfertool with the /export_FILE parameter it is possible to export a database into a file.
Parameters
/FILE:<location and name name of target file> |
Location and filename where the data is exported to. |
/ds:<DB> |
Source database name. |
/ds_user:<username> |
Source database username. |
/ds_pwd:<user's password> |
Source database user's password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
/NOCONFIRM |
Do not ask for confirmations |
/DEBUG: |
Write a debug log file to the specified location. |
/SILENT |
No UI is shown. When using this parameter, /NOCONFIRM is not needed. |
/SKIP_SC_MODELS:<list of model ID's> |
A comma-separated list of QPR Metrics model ID's that are not written to the export file. |
/SKIP_PG_MODELS:<model ID's> |
A comma-separated list of QPR Modeling Client model ID's that are not written to the export file. |
/INCLUDE_SC_MODELS:<model ID's> |
A comma-separated list of QPR Metrics model ID's defining which models are written to the export file. When using this parameter, only the listed models are exported. |
/INCLUDE_PG_MODELS:<model ID's> |
A comma-separated list of QPR Modeling Client model ID's defining which models are written to the export file. When using this parameter, only the listed models are exported. |
Example
QPR.TransferTool.exe /export_FILE /FILE:c:\76.dat /ds:QPR_76_ACCESS_DEMO /ds_user:user /ds_pwd:password /LOG:c:\log.txt
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Import File
By starting QPR Transfertool with the /import_FILE parameter it is possible to import data from a file into a database.
Note that it is possible to overwrite an existing database using this parameter!
Parameters
/FILE:<location and name name of source file> |
Location and filename where the data is imported from. |
/dt:<DB> |
Target database name. |
/dt_user:<username> |
Target database username. |
/dt_pwd:<user's password> |
Target database user's password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
/NOCONFIRM |
Do not ask for confirmations. |
/DEBUG:<location and name name of log file> |
Write a debug log file to the specified location. |
/SILENT |
No UI is shown. When using this parameter, /NOCONFIRM is not needed. |
/SKIP_SC_MODELS:<model ID's> |
A comma-separated list of QPR Metrics model ID's that should not be imported to the database from the import file. |
/SKIP_PG_MODELS:<model ID's> |
A comma-separated list of QPR Modeling Client model ID's that should not be imported to the database from the import file. |
/INCLUDE_SC_MODELS:<model ID's> |
A comma-separated list of QPR Metrics model ID's defining which models are imported to the database. When using this parameter, only the listed models are imported. |
/INCLUDE_PG_MODELS:<model ID's> |
A comma-separated list of QPR Modeling Client model ID's defining which models are imported to the database. When using this parameter, only the listed models are imported. |
Example
QPR.TransferTool.exe /import_FILE /FILE:c:\76.dat /dt:QPR_2017-1_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Merge QPR Modeling Client Attributes
By starting QPR Transfertool with the /MergePGAttributes parameter, you can merge duplicate custom attributes in a model. Note: With Oracle, administrator rights are needed for performing this operation.
Parameters
/dt:<DB> |
Target database name. |
/dt_user:<username> |
Target database username. |
/dt_pwd:<user's password> |
Target database user's password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
Example
QPR.TransferTool.exe /MergePGAttributes /dt:QPR_2017-1_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Graph Layout Mass Operation
By starting QPR Transfertool with a /GRAPH_LAYOUT_MASS_OPERATION parameter, it is possible to modify settings related to period or series for all graph layouts in the database. This operation is not made during a database transfer, but is meant for doing changes to a database already at the current version. Before doing this operation, shut down all QPR servers.
Mandatory parameters
When doing a graph layout mass operation, you must specify the target database with the /DT: parameter (and /DT_USER: and /DT_PWD: parameters if the database requires username and password for login).
You must also use /MODEL: parameter to specify whether you want the modification to target all models or some individual model. The syntax is following:
/MODEL:ALL
or
/MODEL:<model id>
You cannot specify more than one individual model. If you want to do modifications to a set of models, you must run Transfertool multiple times. Because the modification process loads all the targeted layouts to memory, it might be wise to run the operation one model at a time for large databases.
You must also give one or both of the following parameters. They specify whether the operation targets custom graph layouts and/or graph layout templates:
/CUSTOM_LAYOUTS
/TEMPLATES
Optional parameters
/ONLY_INDICATORS |
If this parameter is given, then all the modifications are done only to items of following types: traffic lights indicator, icon indicator, linear gauge indicator, circular gauge indicator. |
/ONLY_CHARTS |
If this parameter is given, then all the modifications are done only to items of following types: history chart. |
/SET_PERIOD:NONE|CURRENT|LATEST |
Sets the item's default period. Setting a specific period id is not supported. If this parameter is left unspecified, the default period of the items is not touched. |
/SET_SERIES:NONE |
Sets the item's default series. Setting a specific series is not supported. If this parameter is left unspecified, the default series of the items is not touched. |
/SET_PERIOD_LOCK |
Sets the 'lock to default' option on for layout items' default period. |
/CLEAR_PERIOD_LOCK |
Sets the 'lock to default' option off for layout items' default period. |
/SET_PERIOD_LEVEL_LOCK |
Sets the 'lock to default' option on for layout items' default period level. In practice, this has only visible effects to items whose type is history chart. |
/CLEAR_PERIOD_LEVEL_LOCK |
Sets the 'lock to default' option off for layout items' default period level. In practice, this has only visible effects to items whose type is history chart. |
/SET_SERIES_LOCK |
Sets the 'lock to default' option on for layout items' default series. This has no effect to items of type history chart. |
/CLEAR_SERIES_LOCK |
Sets the 'lock to default' option on for layout items' default series. This has no effect to items of type history chart. |
Here are some examples of QPR Transfertool command line usage:
QPR.TransferTool.exe /DT:"ACCESSDEMO" /GRAPH_LAYOUT_MASS_OPERATION /CUSTOM_LAYOUTS /TEMPLATES /MODEL:ALL /SET_PERIOD:CURRENT /SET_PERIOD_LEVEL_LOCK /ONLY_CHARTS
Sets the default period to current and period level lock on for all charts in all graph layouts in all models of the accessdemo database.
QPR.TransferTool.exe /DT:"ACCESSDEMO" /GRAPH_LAYOUT_MASS_OPERATION /CUSTOM_LAYOUTS /MODEL:1234567 /SET_PERIOD:NONE /SET_SERIES:NONE /CLEAR_PERIOD_LOCK /CLEAR_SERIES_LOCK
Sets the default period and series to none and period and series locks off for all layout items (indicators, charts, and other layouts items that use periods and series) in all custom graph layouts in the model whose id is 1234567 in the Access demo database.
The transfertool log will report the number of layouts processed and any error messages.
Always remember to backup your database before doing any operations, as there is no way to revert to the previous state once the operations are finished!
Search and Replace Text Inside All Text Box Symbol Layout Items
By starting QPR Transfertool with the /LAYOUT_MASS_OPERATION /REPLACE_TEXT parameters, it is possible to perform a search and replace operation inside the text of all text box layout items in the model.
Parameters
/dt:<DB> |
Target database name. |
/dt_user:<username> |
Target database username. |
/dt_pwd:<user's password> |
Target database user's password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
/REPLACE_TEXT:"<sourcestring1>";"<targetstring1>";"<sourcestring2>";"<targetstring2>";etc. |
An unlimited list of string pairs to search for (sourcestring) and to be replaced (targetstring). Switch-around is also supported. That is, if the list of search-replace strings is a,b,b,a, then the end result is that all instances of "a" that were in the text before the start of the operation are changed to "b", and vice versa. Mandatory. |
/MODEL:ALL or <model id> |
Specifies whether you want the modification to target all models or some individual model. Mandatory. |
Example
QPR.TransferTool.exe /DT:"ACCESSDEMO" /LAYOUT_MASS_OPERATION /REPLACE_TEXT:"<originalscorecardname>";"<scorecardname>";"<scorecardname>";"<originalscorecardname>" /MODEL:ALL
Remove Dead Links from Actions
By starting QPR Transfertool with the /REPAIR_ACTION_PARENTS parameter, you can remove those links in actions that point to QPR Metrics or QPR Modeling Client objects which no longer exist in the used database.
Parameters
/dt:<DB> |
Target database name. |
/dt_user:<username> |
Target database username. |
/dt_pwd:<user's password> |
Target database user's password. |
/LOG:<location and name name of log file> |
The specific location and filename for the log created by Transfertool. If not specified, Transfertool will write a log into the C:\ProgramData\QPR Software\QPR 2017\2017.1\Servers\Logs folder. |
Example
QPR.TransferTool.exe /REPAIR_ACTION_PARENTS /dt:QPR_2017-1_ACCESS_DEMO /dt_user:user /dt_pwd:password /LOG:c:\log.txt