ControlTier > core
 
 
PDF -icon
PDF

Package

An interface to a software package.

Overview

Package: An interface to a software package.

Documentation

Documentation is available on the ControlTier Wiki: Core Type Guide - Package

Design

Super Type
Managed-Entity
Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name Package

Constraints

Allowed Child Dependencies

Allowed Parent Dependencies

Allowed Property Values

Property Allowed Values Default Enforced
package-vendor
  • default
  • default
false

Attributes

Defaults for Imported Attributes

Name Default Description
package-create-script ${modules.dir}/Package/bin/create.xml script to execute for create command
package-delete true Boolean value: determines whether to delete the package after processing
package-extract-script ${modules.dir}/Package/bin/extract.xml script to execute for extract command
package-finish-script ${modules.dir}/Package/bin/finish.xml script to execute for finish command
package-get-script ${modules.dir}/Package/bin/get.xml script to execute for get command
package-isinstalled-executable executable to run for assertPackageIsInstalled command.
package-isinstalled-script ${modules.dir}/Package/bin/is-installed.xml script to execute for assertPackageIsInstalled command
package-isuninstalled-executable executable to run for assertPackageIsUninstalled command
package-isuninstalled-script ${modules.dir}/Package/bin/is-uninstalled.xml script to execute for assertPackageIsUninstalled command
package-prepare-script ${modules.dir}/Package/bin/prepare.xml script to execute for prepare command
package-purge-script ${modules.dir}/Package/bin/purge.xml script to execute for purge command
package-remove-script ${modules.dir}/Package/bin/remove.xml script to execute for remove command
package-unpack true Boolean value: determines whether to extract the package archive (implemented in extract command of subtypes)
package-upload-script ${modules.dir}/Package/bin/upload.xml script to execute for upload command
package-verified-executable executable to run for assertPackageIsVerified command
package-verified-script ${modules.dir}/Package/bin/is-verified.xml script to execute for assertPackageIsVerified command

Commands

View the available commands in the User Reference.

Related Types

The following types are defined for use with Package.

PackageCommandExecutable

Overview

PackageCommandExecutable: The executable used by a Package command

Design

Super Type
PackageSetting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ant
  • bash
  • cmd.exe
  • sh
  • bash
false
settingType
  • ant
  • bat
  • sh
  • sh
false

PackageCommandScript

Overview

PackageCommandScript: The script used by a Package command

Design

Super Type
PackageSetting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingType
  • ant
  • batch
  • sh
  • sh
false

PackageCreateScript

Overview

PackageCreateScript: The script used by create command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/create.bat
  • ${module.dir}/bin/create.sh
  • ${module.dir}/bin/create.xml
  • ${module.dir}/bin/create.sh
false

Attributes

Exported Attributes
Name Property
package-create-script settingValue

PackageDelete

Overview

PackageDelete: Boolean which determines whether to delete the package after processing

Design

Super Type
PackageSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
package-delete settingValue

PackageExtractScript

Overview

PackageExtractScript: The script used by extract command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/extract.bat
  • ${module.dir}/bin/extract.sh
  • ${module.dir}/bin/extract.xml
  • ${module.dir}/bin/extract.sh
false

Attributes

Exported Attributes
Name Property
package-extract-script settingValue

PackageFiltersfile

Overview

PackageFiltersfile: The filtersfile used during finish

Design

Super Type
PackageSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies
Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${entity.properties}
  • ${module.dir}/type.properties
  • ${module.dir}/type.properties
true

Attributes

Exported Attributes
Name Property
package-filtersfile settingValue

PackageFinishScript

Overview

PackageFinishScript: The script used during finish

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/finish.bat
  • ${module.dir}/bin/finish.sh
  • ${module.dir}/bin/finish.xml
  • ${module.dir}/bin/finish.sh
false

Attributes

Exported Attributes
Name Property
package-finish-script settingValue

PackageGetScript

Overview

PackageGetScript: The script used by get command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/get.bat
  • ${module.dir}/bin/get.sh
  • ${module.dir}/bin/get.xml
  • ${module.dir}/bin/get.sh
false

Attributes

Exported Attributes
Name Property
package-get-script settingValue

PackageIsInstalledExecutable

Overview

PackageIsInstalledExecutable: The executable used during assertPackageIsInstalled

Design

Super Type
PackageCommandExecutable
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
package-isinstalled-executable settingValue

PackageIsInstalledScript

Overview

PackageIsInstalledScript: The script used during assertPackageIsInstalled

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/is-installed.bat
  • ${module.dir}/bin/is-installed.sh
  • ${module.dir}/bin/is-installed.xml
  • ${module.dir}/bin/is-installed.sh
false

Attributes

Exported Attributes
Name Property
package-isinstalled-script settingValue

PackageIsUnInstalledExecutable

Overview

PackageIsUnInstalledExecutable: The executable used during assertPackageIsUnInstalled

Design

Super Type
PackageCommandExecutable
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
package-isuninstalled-executable settingValue

PackageIsUnInstalledScript

Overview

PackageIsUnInstalledScript: The script used during assertPackageIsUnInstalled

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/is-uninstalled.bat
  • ${module.dir}/bin/is-uninstalled.sh
  • ${module.dir}/bin/is-uninstalled.xml
  • ${module.dir}/bin/is-uninstalled.sh
false

Attributes

Exported Attributes
Name Property
package-isuninstalled-script settingValue

PackageIsVerifiedExecutable

Overview

PackageIsVerifiedExecutable: The executable used during assertPackageIsVerified

Design

Super Type
PackageCommandExecutable
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
package-verified-executable settingValue

PackageIsVerifiedScript

Overview

PackageIsVerifiedScript: The script used during assertPackageIsVerified

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/is-verified.bat
  • ${module.dir}/bin/is-verified.sh
  • ${module.dir}/bin/is-verified.xml
  • ${module.dir}/bin/is-verified.sh
false

Attributes

Exported Attributes
Name Property
package-verified-script settingValue

PackagePrepareScript

Overview

PackagePrepareScript: The script used during prepare

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/prepare.bat
  • ${module.dir}/bin/prepare.sh
  • ${module.dir}/bin/prepare.xml
  • ${module.dir}/bin/prepare.sh
false

Attributes

Exported Attributes
Name Property
package-prepare-script settingValue

PackagePurgeScript

Overview

PackagePurgeScript: The script used by purge command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/purge.bat
  • ${module.dir}/bin/purge.sh
  • ${module.dir}/bin/purge.xml
  • ${module.dir}/bin/purge.sh
false

Attributes

Exported Attributes
Name Property
package-purge-script settingValue

PackageRemoveScript

Overview

PackageRemoveScript: The script used by remove command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/remove.bat
  • ${module.dir}/bin/remove.sh
  • ${module.dir}/bin/remove.xml
  • ${module.dir}/bin/remove.sh
false

Attributes

Exported Attributes
Name Property
package-remove-script settingValue

PackageSetting

Overview

PackageSetting: A generic configuration setting for a package

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies

PackageUnpack

Overview

PackageUnpack: Boolean which determines whether the package will be unpacked

Design

Super Type
PackageSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
package-unpack settingValue

PackageUploadScript

Overview

PackageUploadScript: The script used by upload command

Design

Super Type
PackageCommandScript
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • ${module.dir}/bin/upload.bat
  • ${module.dir}/bin/upload.sh
  • ${module.dir}/bin/upload.xml
  • ${module.dir}/bin/upload.sh
false

Attributes

Exported Attributes
Name Property
package-upload-script settingValue