# CI Reference

## Configuration Item Overview

### Deployables

### Deployeds

### Containers

### Other Configuration Items

## Configuration Item Details

### udm.Application

Interfaces | udm.ConfigurationItem

An application. Each version of the application is a separate package.

### udm.BaseConfigurationItem

Default implementation of a CI that provides ID, name and type information.

### udm.BaseContainer

Virtual Type
Interfaces | udm.Taggable, udm.ConfigurationItem, udm.Container

The supertype of all Containers.

|  | Public Properties
--- | --- | ---
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.

### udm.BaseDeployable

Virtual Type
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

The supertype of all Deployables.

|  | Public Properties
--- | --- | ---
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

### udm.BaseDeployableArchiveArtifact

Virtual Type
Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

An archive artifact that can be deployed

|  | Public Properties
--- | --- | ---
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = false
|  | Whether to scan this artifact for placeholders when it is imported
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

### udm.BaseDeployableArtifact

Virtual Type
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem

The supertype of all DeployableArtifacts.

|  | Public Properties
--- | --- | ---
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = true
|  | Whether to scan this artifact for placeholders when it is imported
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

### udm.BaseDeployableFileArtifact

Virtual Type
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A file artifact that can be deployed

|  | Public Properties
--- | --- | ---
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = true
|  | Whether to scan this artifact for placeholders when it is imported
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

### udm.BaseDeployableFolderArtifact

Virtual Type
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

A folder artifact that can be deployed

|  | Public Properties
--- | --- | ---
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = true
|  | Whether to scan this artifact for placeholders when it is imported
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

### udm.BaseDeployed

Virtual Type
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

The supertype of all Deployeds.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

### udm.BaseDeployedArtifact

Virtual Type
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

The supertype of all DeployedArtifacts.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

### udm.BaseEmbeddedDeployable

Virtual Type
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Description unavailable

### udm.BaseEmbeddedDeployed

Virtual Type
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

### udm.CompositePackage

Type Hierarchy | udm.Version >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

A container of DeploymentPackages that is a DeploymentPackage itself.

|  | Parent
--- | --- | ---
|  | application : CI<udm.Application >
|  | The application this version belongs to.

|  | Public Properties
--- | --- | ---
|  | packages : LIST_OF_CI<udm.Version >
|  | The DeploymentPackages that make up this CompositePackage.

### udm.Configuration

Virtual Type
Interfaces | udm.ConfigurationItem

Contains deployment configuration information

### udm.DeployedApplication

Interfaces | udm.ConfigurationItem

A deployment of an application package or a deployable artifact to a middleware CI or an environment.

|  | Parent
--- | --- | ---
|  | environment : CI<udm.Environment >
|  | Environment

|  | Public Properties
--- | --- | ---
|  | deployeds : SET_OF_CI<udm.Deployed>
|  | The deployed items that have been deployed to the environment
|  | orchestrator : STRING = default
|  | The orchestrator that is used to deploy the application
|  | version : CI<udm.Version >
|  | The package that has been deployed to the environment

### udm.DeploymentPackage

Type Hierarchy | udm.Version >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

A package of a certain version of an application. Groups all deployable artifact CIs for an application for a certain version. Is contained by the Application CI.

|  | Parent
--- | --- | ---
|  | application : CI<udm.Application >
|  | The application this version belongs to.

|  | Children
--- | --- | ---
|  | deployables : SET_OF_CI<udm.Deployable>
|  | The set of deployables that are part of this package

### udm.Dictionary

Interfaces | udm.ConfigurationItem

A Dictionary contains key-value pairs that can be replaced

|  | Public Properties
--- | --- | ---
|  | entries : MAP_STRING_STRING
|  | The dictionary entries
|  | restrictToApplications : SET_OF_CI<udm.Application >
|  | Only apply this dictionary to the applications mentioned
|  | restrictToContainers : SET_OF_CI<udm.Container>
|  | Only apply this dictionary to the containers mentioned

### udm.EncryptedDictionary

Type Hierarchy | udm.Dictionary >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

An EncryptedDictionary contains keys and encrypted values that can be replaced. Values are encrypted when they are stored and decrypted before being used.

|  | Public Properties
--- | --- | ---
|  | entries : MAP_STRING_STRING
|  | The dictionary entries
|  | restrictToApplications : SET_OF_CI<udm.Application >
|  | Only apply this dictionary to the applications mentioned
|  | restrictToContainers : SET_OF_CI<udm.Container>
|  | Only apply this dictionary to the containers mentioned

### udm.Environment

Interfaces | udm.ConfigurationItem

Groups infrastructure CIs and dictionaries and serves as a target for deployment.

|  | Public Properties
--- | --- | ---
|  | dictionaries : LIST_OF_CI<udm.Dictionary >
|  | The dictionaries providing placeholder values. If the same entry exists in multiple dicitonaries, the first one in the list is taken.
|  | members : SET_OF_CI<udm.Container>
|  | The infrastructure components of this Environment

### udm.Parameters

Interfaces | udm.ConfigurationItem

Default implementation of a CI that provides ID, name and type information.

### udm.Version

Virtual Type
Interfaces | udm.ConfigurationItem

A version of an application .

|  | Parent
--- | --- | ---
|  | application : CI<udm.Application >
|  | The application this version belongs to.