Property description
The package property is the highest-level property in a Dawiso package as it defines the package name, key, assets etc.
Tip
See best practices for working with packages.
Minimal JSON
{
"package": {
"key": "",
"assets": {}
}
}Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the package used for referencing the package in all operations (add/remove, install, uninstall). If a value for this parameter is specified, it will override the value that was set during the package creation process through the UI. The key can be changed only before the initial package installation. If you change the key of an installed application package, the application will be removed from your spaces along with all stored objects. | string | Yes |
assets* | Wrapper for all nested properties in a package. For patch packages, each defined asset should include an action property which specifies what should be modified. For more information, see Patch Packages. See supported action values. | nested property | Yes |
autoInstall | Marks this package as one the Marketplace can install on its own. It doesn’t install the packages listed in dependsOn. The Marketplace installs it once every dependsOn package is already installed or is also being auto-installed in the same pass. If a dependency is neither installed nor auto-installable, the package is never selected. Available only for regular and data packages — not patch or automation. | boolean | No |
basePackageKey | Unique key of the base package the patch is modifying. Mandatory for patch packages. | json | No |
changeLog | A simple array of short comments for individual package versions, which has no influence on package validation. | array | No |
dependsOn | Specifies which packages must be installed prior to the current package. If version is null then any version of the package can be installed. Mandatory for patch packages in case of multiple dependencies. | array | No |
name | Name of the package. If a value for this parameter is specified, it will override the value that was set during the package creation process through the UI. | string | No |
provider | Author of the package. | string | No |
runAfter | Specifies which packages need to be executed before the patch package. Mandatory for patch packages. | json | No |
settings* | Specifies default translations namespace, search templates, notifications, etc. Property not allowed for patch packages. | nested property | No |
type | Package type. For more information, see Patch Packages. See supported type values. | string | No |
* settings and assets are further explained in their specific articles.
Supported action values
| Value | Description |
|---|---|
add | All required properties of the added asset have to be included. |
delete | Package has to include identification properties (e.g., key or component). |
update | Package has to include identification properties (e.g., key or component) + properties to be updated. |
Supported type values
| Value | Description |
|---|---|
base | Reserved for core Dawiso packages. |
data | Seeds object data into a target application. |
| Null | No type, a normal installation package. |
patch | Allows minor modifications to core packages. |
Tip
Admins don’t have to hand-author the data asset. Export object data, in Settings, generates a scope from an existing application’s objects in one space — see Export object data. After install, the outcome shows as a badge on the package detail page: Data seeded, Data seeding skipped, or Data partially seeded when some scopes installed and others did not.