Export command for common metadata assets
You can export most types of common metadata assets by using the istool export command with the -commonmetadata parameter.
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 common metadata assets to a newer version of InfoSphere Information Server.
- Implemented data resources
- Business intelligence (BI) assets
- Physical data model assets
- Data connections
- Contract libraries
The export creates an archive file, which by default has the suffix .isx.
To export logical data model assets, see Export command for logical data model assets.
To export all custom attributes, see Export command for custom attributes.
For command information on exporting all common metadata assets in order 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 for implemented data resource assets, BI assets, physical data model assets, and miscellaneous common metadata assets
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"]
–commonmetadata '[-base "beginning_section_of_identity_string"]
asset1 [asset2 asset3 ...]
[-contactAssignmentOnly]
[-includeContactAssignment]
[-includeAnnotation]
[-includeDataConnection]
[-batchAssets number_of_assets_to_batch]
'
[-contactAssignmentOnly]
[-includeContactAssignment]
[-includeAnnotation]
[-includeDataConnection]
[-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
- 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 -cm command. Not supported with the -preview parameter. For more information, see Using a response file with istool export and istool import commands.
- -commonmetadata | -cm 'identity_string_information options'
- Required. Specifies that common metadata assets 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.
Output
A return value of 0 indicates successful completion. Any other value indicates failure.
Examples
The following command exports all the tables and associated annotations in the database schema named schema1 to the file myarchive.isx.export –dom ABC:9443 –username user1 –password pass1 -archive "c:\myarchive.isx" -maxArchiveSize 50 –commonmetadata '/host1/db1/schema1/*.tbl -includeAnnotation'The following command exports all the contact assignments that are associated with tables in the database schema named schema1.
export –dom ABC:9443 –u user1 –p pass1 -ar "c:\myarchive.isx" –cm '/host1/db1/schema1/*.tbl -contactAssignmentOnly'The following command exports the two specified hosts.
export –dom ABC:9443 –u user1 –p pass1 -ar "c:\myarchive.isx" –cm '/host1.hst /host2.hst'The following command uses the -base option to export three tables that are in schema1.
export –dom ABC:9443 –u user1 –p pass1 -ar "c:\myarchive.isx" –cm '-base "/host1/db1/schema1/" tab1.tbl tab2.tbl tab506.tbl'The following command exports all the BI report queries in all BI reports within bi_folder2.
export –dom ABC:9443 –u user1 –p pass1 -ar "c:\myarchive.isx" –cm '/bi_server1/bi_folder2/*/*/*.rds'The following command exports bi_report1, which is in bi_folder2, a subfolder of bi_folder1 on biserver1.
export -dom ABC:9443 -u user1 -p pass1 -ar "c:\myarchive.isx" -cm '/bi_server1/bi_folder1/bi_folder2/bi_report1.rdf'The following command uses the -base option to export bi_report1, which is in the subfolder bi_folder2, and also to export the subfolder bi_folder3.
export -dom ABC:9443 -u user1 -p pass1 -ar "c:\myarchive.isx" -cm '- base "/bi_server1/bi_folder1" bi_folder2/bi_report1.rdf bi_folder3.fld'The following command exports all the design tables in the physical data model physicalmodel1 in namespace1..
export –dom ABC:9443 –username user1 –password pass1 -archive "c:\myarchive.isx" –commonmetadata '/namespace1/physicalmodel1/*.dtl’The following command uses the -base option to export all the design tables and design stored procedures in physicalmodel1.
export –dom ABC:9443 –username user1 –password pass1 -archive "c:\myarchive.isx" –commonmetadata '-base “/namespace1/physicalmodel1” *.dtl *.dp’The following command exports all data connections.
export –dom ABC:9443 –u user1 –p pass1 -ar "c:\myarchive.isx" –cm '/*/*.dcn'The following command exports all the tables using the -batchAssets option.
export –dom ABC:9443 –username user1 –password pass1 -archive "c:\myarchive.isx" –commonmetadata '/*/*/*/*.tbl -batchAssets 100'