istool export -all

You can export most types of assets with a single command by using the istool export command with the -all parameter.

Purpose

You can use the -all parameter to export assets from the metadata repository to a file that can be imported into a different instance of InfoSphere® Information Server. For example, you can export from a development environment and import the file into a production or test environment. You can also migrate the assets to a newer version of InfoSphere Information Server.

By using the -all parameter, you can export all metadata assets except for the following types:
  • InfoSphere DataStage® and QualityStage® assets, such as projects, jobs, and stages.
  • InfoSphere Information Governance Catalog assets, such as categories, terms, information governance rules, information governance policies, extended data sources, and extension mapping documents.
The -all parameter automatically uses the following options to include related assets when metadata is exported:
  • Common metadata: -includeContactAssignment, -includeAnnotations
  • InfoSphere FastTrack: -includeDependent
  • InfoSphere Information Analyzer: -tablelevel, -includeReports, -includeAllDataClasses, -includeResultHistory, -includeCommonMetadata, -includeProjectRoleAssignments
  • Security user: –includeCredential, --includeRoles, -includeCredentialMappings, –includeUserGroupMemberships
  • Security group: -incRole, -incGrpUsrMems
  • Reports: -includeAllReportResults
You cannot separately specify or not specify the include options when you run istool export -all.

The export creates an archive file, which has the suffix .isx.

To import the exported assets into the target environment, you can use the istool import command with the -all parameter.

Note: Data connections that are exported when you use the -all parameter do not work in the target environment unless the name of the target host system is the same as the name of the source host system. When that is not the case, export only data connections by using the -cm parameter. Import the data connections by using a mapping file to specify the source host name as the current value and the target host name as the new value.

Prerequisites

You must have the required roles to export all of the supported asset types. Users who have the Suite Administrator role and the Common Metadata User role can export all supported asset types.

You must run istool commands from a computer where the istool framework or required products are installed. If you are transferring assets from InfoSphere FastTrack or InfoSphere Streams, run the command from a client tier computer. See Location of the istool command line.

The preferred way to run this command is in the istool command-line window. If you run this command in your operating system command-line window or in scripts, you must add istool before the command name.

Command syntax for istool export -all

Optional parameters and values in the syntax are enclosed in brackets, [ ].

export 
authentication parameters
[generic parameters]
-archive "file_name_and_path" 
[-maxArchiveSize number_of_megabytes]
[-updatearchive] 
[-abortIfError number_of_errors]
–all
[-preview] | [-responseFile "file_name_and_path"]

Parameters

authentication parameters
Required. All asset interchange commands use authentication parameters to connect to a specific installation of InfoSphere Information Server.
generic parameters
The generic parameters are available to all asset interchange commands. Use the generic parameters to request help on command syntax, to specify silent or verbose operation, and to use a script to run commands.
-archive |-ar "file_name_and_path"
Required. Specifies the file that the assets are exported to.
-maxArchiveSize | -mas number_of_megabytes
For enhanced export and import performance, creates additional archive files when the size of the export file exceeds the specified number of megabytes. For example, if you specify 500 and the total size of the export is 1,300 MB, two more archive files are created.
Each additional archive file is named with the name that you specify as a value for the -archive parameter, followed by an underscore and a sequential number. For example, if you specify the file name myArchive.isx and two more archives are created, the additional archives are named myArchive_1.isx and myArchive_2.isx.
When you import the exported archive files, if you specify the first archive file in the import command, for example myArchive.isx, all additional files are automatically imported. However, if you specify a subsequent file, for example, myArchive_1.isx, only that file is imported.
-updatearchive | -up
Adds exported assets to the content of the archive file if the file exists. If you do not specify -updatearchive, the content of the existing archive file is overwritten.
-abortIfError | -abort number_of_errors
Stops the export after the specified number of errors.
-all
Required. Specifies that all asset types that are supported for the -all parameter are exported.
-preview | -pre
Previews the export. The preview lists the assets that will be exported when the export runs.
-responseFile | -rf "file_name_and_path"
Specifies the name and path of a response file that contains assets that failed to export during a run of a previous istool export command. Not supported with the -preview parameter. For more information, see Using a response file with istool export and istool import commands.

Output

A return value of 0 indicates successful completion. Any other value indicates failure.

Example

The following command exports all supported assets in the metadata repository to the myarchive.isx file, and creates additional archive files whenever the file size exceeds 500 MB.
export –dom ABC:9443 –username user1 –password pass1 
-archive "c:\myarchive.isx" -maxArchiveSize 500 –all