You
can use the istool command line interface (CLI) to
export assets to an archive file. The default extension of the archive
file is .isx.
Purpose
Use
the DataStage command option
with the istool export command to export IBM® InfoSphere® DataStage® and QualityStage® assets
to an archive file on the local file system. You can
then use the istool import command with the DataStage command option
to restore the exported assets into a different IBM InfoSphere Information Server metadata
repository.
You
must have an InfoSphere DataStage and QualityStage role
that grants you permission to edit the assets that you
are exporting.
Command syntax
istool export
authentication options
[generic options]
-archive "pathname" [-updatearchive]
[-preview ]
[-abortIfError=number_of_errors]
-datastage ' [ -base="server[:port]/project"]
[-includedependent]
[-nodesign]
[-includeexecutable]
"dsServer[:port]/project/folder/name.type" '
Command options
- authentication options
- Use
authentication options to connect to a specific installation
of InfoSphere Information Server.
- generic options
- Use the generic options to request help on command syntax, or
to specify silent or verbose operation.
- -archive
"archive_pathname" or -ar "archive_pathname"
- Specifies the path name for the file that the assets are exported
to.
- -updatearchive or -up
- Specifies that the archive file is updated if it exists (otherwise
it is overwritten)
- -preview or -pre
- Specify this option to preview the export operation without exporting
the assets.
- -AbortIfError number_of_errors or
-abort number_of_errors
- Specifies that
the export stops if the specified number of errors
occur
- -datastage ' "server/project/folder/name.type"
' or -ds ' "server/project/folder/name.type"
'
- Specifies that InfoSphere DataStage and QualityStage assets
are to be exported. Specifies the assets that are to
be added to the export file (see Asset paths for InfoSphere DataStage and QualityStage assets).
You can copy and paste asset names from the InfoSphere Information Server manager.
- -nodesign
- Excludes
design objects from the export. Use together with the
-includeexecutable option to export only runtime executables.
- -includedependent or -incdep
- Includes dependent assets. For example, if you export a job named
myjob that uses the table definition named salesdata, then specifying
the -includedependent causes the table definition to be automatically
included when the job is exported.
- -includeexecutable
or -incexe
- Includes runtime executables. Some assets
do not have executable
components. If you use this option and an asset in the export does
not have an executable component, a warning is generated but the export
does not fail as a result.
- -base
"dsServer[:port]/project/[folder]"
- You can optionally use the -base argument to specify a base path.
This path is then prefixed to all the asset path names that you specify.
For example, if your base option specifies dsServer/project, then
your asset path only specifies folder/name.type.
Note: If you specify -includedependent, the archive
file can include common metadata assets. When you import the archive
file, you must specify the -cm option on the command line. Otherwise,
the common metadata assets are not imported.
Exit
status
A return value of 0 indicates
successful completion, any other value indicates failure. The list
of exit codes is shown in the command help. Enter istool
export -help to see the list of possible exit codes for
the export command.
Error
handling
When you are exporting more
than one object, a failure does not interrupt the operation. If only
one object is successfully exported, an archive file is still created.
If no objects are exported, no archive file is created. The exit status
reports an error if one or more objects cannot be exported.
Examples
The following command exports the
parallel job named ajob from the project named proj on the computer
named sliver. The job is located in the Mine subfolder of the Jobs
folder. The command also exports all the server jobs in folder2 and
its subfolders in the project named anotherProj on the computer named
serv2. In this InfoSphere Information Server system, both sliver and
serv2 belong to the same domain (sliver:9080). All the assets are
written to the archive file
C:\arc.isx.
istool export –domain sliver:9080 -username user1 -password pass1
-archive "c:\arc.isx" -datastage ' "sliver:5000/Proj/Jobs/Mine/ajob.pjb"
"serv2/anotherProj/folder2/*/*.sjb" '
The following command exports all the assets in the folder
named tabledefinitions, and all the parallel jobs in the Pivotal subfolder
of the Jobs folder. All these folders belong to the project named
anotherProj on the computer named serv2. The –updatearchive option
is specified, so if the specified archive file, C:\arc.isx, exists,
the assets are added to the archive file. The -includedependent option
is specified so that any shared tables that are related to the table
definitions are also exported.
istool export -domain sliver:9080 -username user1 -password pass1
-archive "c:\arc.isx" -updatearchive -datastage '-base="serv2/anotherProj"
"tabledefinitions/*.tbd" "Jobs/Pivotal/*.pjb" -includedependent'
The following example exports only job executables for
the parallel jobs in the Jobs folder. The folder belongs to the project
named dstage on the computer named sliver. No design time assets are
exported. The job executables are written to the archive file
c:\runtime.isxistool export -domain sliver:9080 -username user1 -password pass1
-archive "c:\runtime.isx" -ds '-nodesign -includeexecutable
"sliver:5000/dstage/Jobs/*.pjb" '
IBM InfoSphere Foundation Tools, IBM InfoSphere Information Server, Version 8.5
