Export command for data class and data collection analysis assets

Purpose

You export the assets into 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 assets to a newer version of InfoSphere Information Server.

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

You can export data class assets, data collection analysis assets, or both with the same command. For more information on the asset types and their identity strings, see Miscellaneous common metadata assets.

Prerequisite

You must have the Suite User role.

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

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] 
[-preview] | [-responseFile "file_name_and_path"] 
–dataclassanalysis '[-base "beginning_section_of_identity_string"][data_class_assets] [data_collection_analysis_assets]
	[-includeClassification]
	[-contactAssignmentOnly] 
	[-includeContactAssignment] 
	[-includeAnnotation]
       [-batchAssets number_of_assets_to_batch]
	'

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

Updates 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 custom attributes that are 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 -ca command. Not supported with the -preview parameter. For more information, see Using a response file with istool export and istool import commands.

-dataclassanalysis | -dca '[-base "beginning_section_of_identity_string"][data_class_assets] [data_collection_analysis_assets] [options]'

Required. Specifies the identity strings of the assets to export. You can specify multiple identity strings, each separated by a space. You must specify either or both of the following types of assets:

• Data class assets: /namespace/data_class_name.dc
• Data collection analysis assets: /project_name.als

You can use wildcards for any variable. If you specify both types of assets or multiple assets, separate the identity strings with a space.

You can export one or more data class assets. Subclasses are exported with their parent data classes, but you cannot specify a subclass by itself. You can export all of the data collection analysis assets that are in one or more InfoSphere Information Analyzer projects.

You can use the following options within the single quotation marks (' ') that follow the -dca parameter:

-base "beginning_section_of_identity_string"

Specifies the beginning section of an identity string that applies to all the assets that you specify in the command. The -base option can be used as a shortcut when each asset is contained in the same identity hierarchy. Surround the value in double quotation marks ("). Specify the remainder of each identity string separately for each asset, separating each with a single space.

Note: Do not specify the final forward slash (/) in the value of the -base option, and do not add that forward slash to the beginning of the values of the remainders of the identity string.

-includeClassification | -inccls

Includes classifications, which contain information about the data fields that are classified by the exported data classes. By default, classifications are not included. If you are transferring the classified assets you might want to include the classifications so that the data classes are linked to the same data fields in the target repository. If you are not planning to transfer the data fields and related metadata such as projects, you might want to export the data classes without classifications.

-includeContactAssignment | -incca

Includes the contact assignments for the exported assets. A contact assignment connects an asset to the person or group who is a contact or steward for the asset.

When imported to a target system with assets, contact assignments are relinked to the people or groups that they connect, if those people and groups exist in the target repository at the time of import.

-includeAnnotation | -incannot

Includes the annotations for the exported assets.

-contactAssignmentOnly | -caonly

Exports only the contact assignments that are associated with the specified assets, not the assets themselves.

When you import contact assignments to a target system, the contact assignments are relinked to the assets, people, or groups that they connect, if those assets, people, and groups exist in the target repository at the time of import.

-batchAssets |-batch number_of_assets_to_batch

For enhanced export and import performance, the option writes the number of assets specified by the batch size into a single xmi contained in the export archive. For example, if you specify 20 as the batch size and the total number of data classes in metadata repository is 100, the archive is created with only 5 XMIs instead of 100 XMIs when the data classes are exported using the -batchAssets option.

Exit status

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