CreatePackage

Creates a zip package that can be used to inject shared data definitions into consumer projects.   

Package files can be identified by filename, or by package name.

Filename

• filename - a full path and filename for the package zip file must be provided.  
  • When CREATING:
    • use "path" key to specify the path, or [path and filename] when creating the package, e.g., "%DATAPATH%NewPackageFileName.zip"
  • When INJECTING:
    • use "path" key to specify the filename when injecting the package (see InjectPackage)
    • use "homePath" key to point to the underlying data files, e.g., "%REPOS%/SourceProject_A" 
  • Existing files of the same name will be overwritten.   
  • Assuming the file is output to %DATAPATH%, the resulting package file can be found in Admin | Remote Files 

Package Name

• package name- usually packages are stored in the storage hub and accessed via the package helperwizard.  
  • To store a package in the hub, use the "name" key and set "push" to true.
  • To use a package created using the name method, use the "name" key in InjectPackage

Notes

• Dependencies are always written into the package file.
• Joins are automatically included between any tables that are in the package.

Package Contents

The following objects are included in a package file:

• tables and fields
• field templates
• reports (free-flow and standardized)
• metadata

Note that datasets and collections are not included in packages.

Project | Create Package

If the Storage Hub has been configured, Packages for the current project can be created using Project | Create Package.  This will create a package of specified name and automatically push it to the hub.  To see the CreatePackage method generated when creating the package, use one of the following methods:

1.  Script Editor | File | Import Definitions.   Select the CreatePackage method and add to the active script.
2.  Press Script Editor | Record before selecting Project | Create Package.  The CreatePackage method will be added to the active script.

For a more detailed look at working with injected data, see Introduction to Data Injection 

Example using explicit "path" to package file (filename)

Use CreatePackage to create package file:

{
  "method": "CreatePackage",
  "path": "%DATAPATH%/06_Packages/dj-localhost_CONSUMER_Test1_20241105_145735_1.zip",
  "push": false,
  "system": false,
  "targetProject": "CONSUMER_Test1",
  "includeProjectMetadata": true,
  "autoLock": false,
  "tables": [
    "*"
  ],
  "reports": [
    "*"
  ],
  "template": [
    "*"
  ],
  "createMetafile": true,
  "project": "CONSUMER_Test1"
}

Use InjectPackage to import package file by filename:

{
  "method": "InjectPackage",
  "path": "%DATAPATH%/06_Packages/dj-localhost_CONSUMER_Test1_20241105_145735_1.zip",
  "homePath": "%REPOS%CONSUMER_Test1",
  "targetProject": "Injection_Test_Basic",
  "includeProjectMetaData": true,
  "sourceName": "Test Consumer Project",
  "sortMode": 0,
  "errorOnMissingDataFiles": false,
  "pull": false,
  "project": "CONSUMER_Test1"
}

Named package files

Use CreatePackage with the "name" property to create a package from CONSUMER_Test1:

{
  "method": "CreatePackage",
  "name": "Consumer_Package1",
  "push": true,
  "system": false,
  "targetProject": "CONSUMER_Test1",
  "includeProjectMetadata": true,
  "autoLock": false,
  "createMetafile": true,
  "project": "CONSUMER_Test1"
}

Then use InjectPackage to inject the data into project Injection_Test_Basic:

{
  "method": "InjectPackage",
  "name": "Consumer_Package1",
  "targetProject": "Injection_Test_Basic",
  "includeProjectMetaData": true,
  "sourceName": "Test Consumer Project",
  "sortMode": 0,
  "errorOnMissingDataFiles": false,
  "pull": true,
  "project": "CONSUMER_Test1"
}

Example created using Project | Create Package

{
  "method": "CreatePackage",
  "includeProjectMetadata": true,
  "createMetafile": true,
  "autoLock": false,
  "push": true,
  "name": "BProject22024-10-31-13-57-26",
  "targetProject": "BProject2",
  "project": "BProject2"
}