Export command for logical data model assets and MDM models

You can export logical data model assets and MDM models by using the istool export command.

Purpose

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

Though logical models and MDM models are not related, the export command uses the same syntax and options, except that you use the -lm parameter to export logical data models assets and the -mdm parameter to export MDM models. .

When you export logical data model assets, any custom attributes and custom attribute values that were created for the logical data model assets are also exported.

When you export MDM models, all assets that are contained by the model are exported.

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

For command information on exporting all common metadata assets to migrate to a new version or environment, see Migrating common metadata assets.

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

Prerequisites

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 optional 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"] 
–lm | –mdm
 '[-base "beginning_section_of_identity_string"]
 asset1 [asset2 asset3 ...] 
  [-contactAssignmentOnly] 
  [-includeContactAssignment] 
  [-includeAnnotation] 
 |

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

-lm | -mdm 'identity_string_information options'

Required. Specifies that logical data model assets or MDM models are exported. Specifies the identity strings of one or more assets to export. The format of the identity string is described in Common metadata asset types and identity strings for the command line. You can use wildcards to specify multiple assets.

Use a single space to separate each asset that you specify. If the containing path of each identity string for the assets that you export is the same, you can use the -base option a single time to specify the beginning part of the identity string. After the -base value, specify the remainder of the identity string for each asset. Identity strings and all options of -logicalmetadata that you specify must be contained within a single set of single quotation marks (').

You can use the following options.

-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.
-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. For example, when a database table has a steward, a contact assignment is used to connect the table to the steward.; Stewards are created in InfoSphere Information Governance Catalog. A steward is a user or user group in InfoSphere Information Server that is responsible for one or more assets. Contacts are created in InfoSphere Information Analyzer. Contacts are people or groups who are not required to have an InfoSphere Information Server login.; 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.
-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.

Exit status

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

Examples

The following command exports an MDM model that is named model1 and all of its annotations to the file myarchive.isx.

export –dom ABC:9443 –username user1 –password pass1 
-archive "c:\myarchive.isx" 
–mdm '/namespace1/model1.mdm -includeAnnotation'

The following command exports all the contact assignments that are associated with any logical data model named model1 in any namespace.

export –dom ABC:9443 –u user1 –p pass1 
-ar "c:\myarchive.isx" 
–lm '/*/model1.lm -contactAssignmentOnly'

The following command exports two specified logical data models.

export –dom ABC:9443 –u user1 –p pass1 
-ar "c:\myarchive.isx" 
-lm '/namespace1/model1.lm /namespace1/model1/nestedModel2.lm'

The following command uses the -base option to export entity1 and domain1 from nestedModel12.

export –dom ABC:9443 –u user1 –p pass1 
-ar "c:\myarchive.isx" 
–lm '-base "/namespace1/model1/nestedModel2" entity1.ent 
nameQualifier1/domain1.dom'

The following command exports the logical relationship that is named relationship1.

export –dom ABC:9443 –u user1 –p pass1 
-ar "c:\myarchive.isx" 
–lm '/namespace1/model1/entity1/namespace1/model1/relationship1.rel'