Export command for InfoSphere Information Analyzer assets

Use the istool export command with the -ia parameter to export some or all of your IBM® InfoSphere® Information Analyzer assets to an archive file.

Purpose

You can use the archive file to import the assets into a different installation of IBM InfoSphere Information Server. For example, you could transfer assets from a development environment to a production environment, or you could migrate assets to a newer version of IBM InfoSphere Information Server.

Note: When you use the command line to export and import InfoSphere Information Analyzer assets, all of the assets that are associated with the specified InfoSphere Information Analyzer project are included in the import or export process. If you want to import or export a subset of data quality components (data rule definitions, rule set definitions, data rules, rule sets, or metrics), you can use the export and import wizards from the Develop > Data Quality workspace of the InfoSphere Information Analyzer client. If you want to export and import global logical variables separately from other project assets, you can use the HOME > Metadata Management > Global Logical Variables workspace of the client.

Analysis assets that were originally imported into the metadata repository by using the InfoSphere Discovery MetaBroker® or DBM File MetaBroker are also included when you export a project.

Note: Archive files of assets that are exported by using the istool command can be imported only by using the istool command line.

To export all assets of all types, see Moving all assets from one metadata repository to another.

Prerequisites

You must have the Project Administrator role.

You must run the command on a computer on the client or engine tier where InfoSphere Information Analyzer is installed.

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 to the command name.

To export data classes that are associated with projects, install the following patches:

Command syntax

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

export 
-archive file_name_and_path
[-maxArchiveSize number_of_megabytes]
[-updatearchive] 
[-abortIfError number_of_errors]
[-preview] | [-responseFile "file_name_and_path"]
-ia ' -projects "[project1 project2 ...]"
  [-includeDataClasses]
  [-includeReports] 
  [-includeCommonMetaData] 
  [-includeProjectRoles] 
  [-includeResultHistory]

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 .isx 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 additional archive files are created with numeric suffixes added to their names. For import, specifying the first archive file imports all. For more information, see common parameters.

-updatearchive | -up

Adds exported assets to the archive file if it 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.

-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 -ia command. Not supported with the -preview parameter. For more information, see Using a response file for istool export and istool import commands.

-ia '-projects "[project1 project2 ...]" export_options'

Required. Specifies that one or more InfoSphere Information Analyzer projects are exported. Includes project names that you specify in the exported archive. You must specify one or more projects. To specify all project names, use an asterisk; for example -projects="*".

You delimit multiple project names with a blank space between each name. If any of the project names contains spaces, use two backslashes (\\) both before and after each project name, regardless of whether it contains spaces. For example: -projects="\\with space\\ \\without_space\\ \\no_space\\". In addition, if there is a black space before any project name, all export options, such as -includeDataClasses, must precede the -projects parameter list in the command. For example:

export -u admin -p admin -ar C:\archive5.isx 
-ia '-includeDataClasses -includeCommonMetadata -projects="\\Project A\\"'

You can use the following export options:

-includeDataClasses | -dataclass: Includes all data classes, including subclasses, that are specified for extended data classification for the project names that are specified in the exported archive.
Note: To use this option, you must install the patches that are listed in the Prerequisites section.. The -includeAllDataClasses option is no longer supported.
-includeCommonMetadata | -inccm: Includes all related common metadata for the project names that are specified in the exported archive. If you use -includeCommonMetadata, you can add the -cm parameter with common metadata options between single quotes to export assets that are related to the exported common metadata. For more information on common metadata options, see Export common metadata.
-includeProjectRoles | -incroles: Includes all project role assignments for the project names that are specified in the exported archive.
-includeReports | -incrpt: Includes reports for the project names that are specified in the exported archive.
-includeResultHistory | -incresult: Includes history for the data quality results.

Examples

The follow example exports all projects to the archive file ia_archive1.isx, and creates multiple archive files if the export exceeds 500 megabytes.

export -u admin -p admin100 -dom KILIMANJARO 
-ar ia_archive1.isx -maxArchiveSize 500 -ia '-projects="*" '

The follow example exports all projects and includes related common metadata, data classes, project role assignments, and related reports.

export -u admin -p admin100 -dom KILIMANJARO -ar ia_archive1.isx 
-ia '-projects="project1" -includeCommonMetadata -includeDataClasses 
-includeProjectRoles  -includeReports'

The following example shows the export of the project1 project as ia_archive1.isx and includes the common metadata for the project and the data connections for databases that are exported with the common metadata.

export -u admin -p admin100 -dom KILIMANJARO -ar ia_archive1.isx 
 -ia '-projects="project1" -includeCommonMetadata' -cm 'includeDataConnection'

The following example shows the export of the project 2 project as ia_archive2.isx:

export -dom localhost:9443 -u admin -p admin -ar ia_archive2.isx
 ia '-projects="\\project 2\\"'

The following example shows the export of the project 3 project and the project4 project as ia_archive3.isx. Because the name project 3 contains a space, each project name is surrounded by double backslashes, and the export options, which export common metadata and reports, must precede the -projects parameter.

export -dom localhost:9443 -u admin -p admin -ar ia_archive3.isx 
 ia '-inccm -incrpt -projects="\\project 3\\ \\project4\\" '

Exit status

When exporting assets, if at least one item is successfully exported, an archive file is created.

Exit status = 0: The package was built successfully.
Values greater than 0: An error occurred.