IDA CREATEPACKAGE command

A package is a compressed file that contains the files needed to deploy all of the UDXs in a project. It provides a way to transfer UDXs from one computer system to another. The IDA CREATEPACKAGE CLPPlus command creates a package and downloads it to your client system.

This command:
  1. Copies all the files in the release subdirectory of the specified project into a compressed file. This file has the same name as the package. If a file with this name already exists in the project directory, it is overwritten.
  2. Retrieves, from the current database, the information needed to create the registration file for the package. The registration file contains the DDL for all the registered UDXs of the specified project, and is used during deployment to register the UDXs on the new system.
  3. Adds the registration file to the compressed file.
  4. Downloads the compressed file, which is now called a package, to your client system, and deletes the original package from the host system.
Note: A package cannot span projects. Therefore, if Project X uses a library from Project Y, you must either:
  • Copy or move the library file from Project Y to Project X before creating a package for Project X.
  • Create separate packages for Projects X and Y and deploy both packages to the same project on the target system.
In either case, you must re-link the Project X library with the Project Y library. To do this:
  1. Download the library from project Y.
  2. Add the downloaded library to the compressed file that contains the source code for project X.
  3. Reissue the deployUDX command. Specify the lib and libdirs to set the project Y library as a dependency for the project X library.

Invocation

You must run this command from the CLPPlus interface.

Authorization

None

Required connection

CLPPlus must be connected to the database.

Command syntax

IDA CREATEPACKAGE

Read syntax diagramSkip visual syntax diagramIDA CREATEPACKAGEPROJECTprojectFORMATtar.gzFORMATtarFORMATzipPACKAGENAMEprojectPACKAGENAMEnameTARGETDIRECTORYcurrent_directory TARGETDIRECTORYdirectory

Parameters

PROJECT | PROJ
The name of the project for which a deployable package is to be created and downloaded.
FORMAT
The type and file extension of the package to be created and downloaded:
  • tar.gz (this is the default)
  • tar
  • zip
PACKAGENAME | PKGNAME
The file name (not including the extension) of the package. The default is the project name.
TARGETDIRECTORY | TARGETDIR
The directory in which the generated package is to be stored. The default is the current working directory.

Examples

The following command creates a package with the name proj1.zip in the current directory:
SQL> IDA CREATEPACKAGE PROJ proj1 FORMAT zip
The following command creates a package with the fully-qualified name /home/user1/pkg01a.tar.gz:
SQL> IDA CREATEPACKAGE PROJ proj1 PKGNAME pkg01a TARGETDIR /home/user1