Creating a Package
This topic describes how to create a package file from a project using the New Package Wizard. To create a package, you first generate a package inventory file. The package inventory file is then used to generate the package. A package is a compressed, portable file (.djar) which can be executed directly from the command line of the engine (see Using Runtime Engine). Or you can provide the package (.djar) file to Integration Manager (see Deploying Design Artifacts to Integration Manager).
Package Inventory File
The package inventory file is an XML file that has the extension .inv.xml. The package inventory file contains a list of all artifacts referenced by a project. For example, if a process references a Data Profile (.dp) file, the Data Profile is included.
The package inventory file is sometimes also referred to as a manifest, archive file, package list, and inventory file.
The New Package Wizard uses the inventory file to create the package (.djar) file. The inventory file is:
• the manifest for what's included in the package (.djar) you create.
• the mechanism for creating the package (.djar).
• used for versioning the package (.djar). For example, the New Package Wizard versions the first package (.djar) 1.0. You can then edit the inventory file and the artifacts it references, as needed. The version of the next package (.djar) generated is incremented to 1.1. There is no limit to the number of package (.djar) files the inventory file generates.
The inventory file is saved to your workspace.
Entry Point
The New Package Wizard also prompts you to specify an entry point. The entry point tells the standalone engine what to execute first. The entry point must be a configuration (.rtc) file in your project. The (.rtc) file can be a process.rtc or map.rtc file.
The entry point cannot be changed in the package (.djar) file.
Package (.djar) File
A package file is a compressed, portable file (.djar) which contains all the artifacts in your project. To deploy the package, you can execute this single (.djar) file directly from the command line of the engine (see Using Runtime Engine), or provide the package (.djar) file to Integration Manager (see Deploying Design Artifacts to Integration Manager).
The package (.djar) file is created in the New Package Wizard using the package inventory (.inv.xml) file.
To create a package:
1. Select the project for which you want to create a package and do any of the following:
• Go to File > New > Package.
• Click the arrow in 
and then click Package.
and then click Package.• Right-click within Project Explorer and then click New > Package.
The New Package (Inventory File) window is displayed.
2. Select the parent folder where you want save the package inventory file.
3. In the Enter Package Name field, type a name for the package file and click Next.
The Select Entry Point and Options window is displayed.
4. Specify the following:
• Choose Process or Map - Click Browse and specify the required runtime configuration file (.process.rtc or .map.rtc).
• Expand macros in references when building package (recommended) - Select this option to expand macros while packaging. Macros in referenced artifact paths are expanded, ensuring a self-contained package for distribution and execution.
• Include Macro Definition File - Select this option to include the macro definition file in the package and then select one of the following:
• Include entire Workspace Macros - Includes the entire macro definition file associated with the workspace. This is selected by default.
• Include only Configuration Macros - Includes the local macros and all the macros from the Configuration tab > Macros section for all the processes and referenced maps.
• Include Global Macros: If you select the Include only Configuration Macros option, it enables selection of the Include Global Macros option. This option allows you to include the global macros from the workspace macro definition file.
Note: In case of duplicate macros, only the local macros configured in the process that is selected as an entry-point is added. For example, consider that there is a local macro named userName in .process.rtc file and another local macro with the same name but with a different value in .map.rtc file and this map is used within the .process.rtc (in a transformation step). When creating the inventory, if you select .process.rtc as entry-point, then the userName from .process.rtc is included in the configurationMacros.json file and not the macro from .map.rtc file.
5. Click Finish.
The package inventory file is created (with extension as .inv.xml) and it opens in the Package Manager Editor tab. It displays all the artifacts that are included in the package.
If you have selected the Include entire Workspace Macro option, then the MacroDefinition.json file is included in the package.
If you have selected the Include only Configuration Macro option, then a new {nameOfPackageEntryPoint)_macros.json file is created in the same location as the workspace macro definition file. This macro definition file includes only the configuration macros used by the entry point map or process. When it is packaged in the djar, this file name is changed to configurationMacros.json, which is required by Integration Manager.
The following information is displayed for the artifacts that are included in the package:
• Main: The main artifact is selected by default. Select the required check box to specify another artifact as the main.
• Type: Indicates the type of artifact (map, process, macro, map configuration, and so on.)
• File: Displays the file name of the artifact that is included in the package.
• Location: Displays the location of the artifact. If the artifact is located outside the workspace or if it contains a macro, then it displays the full path. If the artifact is in the same workspace, then it displays the path relative to the workspace.
• Version: Displays the version number of the artifact.
Also, the .inv.xml file is available within the project folder.
Note: The package inventory file is created relative to where the project is located.
6. To create a package, do the following:
• Open the package inventory file (if it is closed).
• Verify that the main entrypoint (process or map) is selected while creating the package.
• Package Name displays the package name. It defaults to the name of the inventory file. You can change this name if required.
• Create external runtime config file - Select this option to create a runtime configuration file in the same location as the djar. The RTC can be used with -RC package execution command line option or the client SDK.
• Overwrite external RTC - Select this option to overwrite an existing RTC. Else, a unique name rtc will be created.
• Package Version displays the version number of the package file. The default is 1.0. You can change this version number.
• Click 
if you want to add files to the package. To remove a file, select the required file and click 
.
if you want to add files to the package. To remove a file, select the required file and click .7. Click Create Package.
The Package Creation Success dialog box displays a confirmation message and the folder where the .djar file is stored.
When you run a .djar that contains a macro definition file, djengine does not automatically use this file. You must specify a macro file that is outside the .djar to use a macro definition file when you run a package.
Package Inventory Changes Pop-up Message
The Package Inventory Changes warning message is displayed or not displayed based on the following conditions:
• If package has extra files and there are other changes, the warning message is displayed and the version number for the artifacts is incremented.
• If there are additional files in package and no other changes have occurred, the warning message is not displayed and the version number for artifacts is not incremented.
Last modified date: 02/01/2024