Initializing help system before first use

Syntax and Usage

Depending on your intentions, insightcmd can require one or more provided parameters.
  • <user> and <password> provide identification and authentication - you will need the SYS_IMPORTEXPORT authority. If you do not provide credentials on the command line, insightcmd requests them interactively.
  • /path/to/storage/my_apps.insight or a similar expression defines the location and name of the export or import file, which should not be placed in your Xpress installation directory. Note that it is standard to give the export files an INSIGHT extension so that they are easily identifiable.
  • <app_name> is the name of a single app to export. If the name contains spaces you must enclose it in quotes.

The --force flag causes an export to overwrite an existing export file of the same name if present. If the specified export file exists and the --force flag is not used, the command returns an error.

Note that once the command has been issued, it cannot be cancelled. CTRL-C and CTRL-ESC will not stop the import or export from continuing.

Usage

To show a description of the command and a list of its available options 
insightcmd [-h|--help]
Examples: 
insightcmd -h
insightcmd --help
Exporting a single app 
insightcmd export [-u|--user <user>] [-p|--password <password>] app <app_name> [--force] /path/to/storage/app.insight
Example: 
insightcmd export app “Campaign Conversion” /path/to/storage/my_apps.insight
If the name of your app includes spaces, you must include it in quotes.
Exporting all apps to separate files 
insightcmd export [-u|--user <user>] [-p|--password <password>] app --all-separate [--force] /path/to/storage/my_apps_folder
Example: 
insightcmd export -u admin-p admin123 app –-all-separate appsdir

where appsdir is the filesystem path of a directory that may or may not already exist. Each app will be exported to that directory as a separate file named after the app.

Exporting all apps to a single file 
insightcmd export [-u|--user <user>] [-p|--password <password>] app [-a|--all] [--force] /path/to/storage/my_apps.insight
Examples: 
insightcmd export –u admin –p admin123 app –a /path/to/storage/my_apps.insight
insightcmd export –u admin –p admin123 app --all --force /path/to/storage/my_apps.insight
The latter command overwrites my_apps.insight if it already exists. 
insightcmd export app –a /path/to/storage/my_apps.insight
With this command, insightcmd will request identification and authentication details interactively.
Importing a folder export file (along with any subfolders within it) 
insightcmd export [-u|--user <user>] [-p|--password <password>] folder [--force] <folder-path> /path/to/storage/my_folder.insight
Example: 
insightcmd export -u admin-p admin123 folder MyApp/MyFolder/MySubFolder folderfile.insight
Exporting the whole repository 
insightcmd export [-u|--user <user>] [-p|--password <password>] repository [--force] /path/to/storage/repository.insight
Example: 
insightcmd export –u admin –p admin123  repository /path/to/storage/my_apps.insight
Importing an app export file—either a single app or an export that contains all apps 
insightcmd import [-u|--user <user>] [-p|--password <password>] app /path/to/apps.insight
Example: 
insightcmd import –u admin –p admin123 app /path/to/apps.insight
Importing a folder of scenarios (along with any subfolders within it) 
insightcmd import [-u|--user <user>] [-p|--password <password>] folder <parent-folder-path> /path/to/file.insight
Example: 
insightcmd import -u admin-p admin123 folder MyApp/MyTargetFolder folderfile.insight
Note: The folder will be imported into the given parent folder (in the example above, the folder exported as MySubFolder is imported as MyApp/MyTargetFolder/MySubFolder)—If the folder name is not available, the imported folder is suffixed with a unique number.
Importing a whole-repository export file 
insightcmd import [-u|--user <user>] [-p|--password <password>] repository /path/to/file.insight
Example: 
insightcmd import –u admin –p admin123 repository /path/to/repository.insight
Parent Topic Using the insightcmd Command Line Tool

© 2001-2023 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.