Preface

This document describes the functionality provided by the BizTalk plugin.

Refer to Deployit Reference Manual for background information on Deployit and deployment concepts.

Overview

The BizTalk plugin is a Deployit plugin that adds the capability to perform BizTalk configuration and deployment tasks.

Features

  • Creates and destroys BizTalk applications in the BizTalk database.
    • Starts and stops BizTalk applications as necessary.
  • Adds and remove BizTalk and plain assemblies to/from the BizTalk database.
  • Imports BizTalk bindings files into the BizTalk database.
  • Imports BizTalk Business Rule Engine (BRE) vocabularies into the BizTalk database.
  • Imports, deploys and undeploys BRE rules into the BizTalk database.
  • Installs BizTalk and plain assemblies in the Global Assembly Cache (GAC) on every BizTalk server (host).

Requirements

  • Deployit requirements:

    • Deployit version 3.8.4 or higher.
  • Infrastructural requirements for the target machine:

    • Administrative access (with elevated privileges) is required to run the PowerShell provider for BizTalk.
      • N.B.: When the machine that runs the PowerShell provider for BizTalk is accessed over WinRM and is then used to connect to a third machine, an error such as Login failed for user 'NT AUTHORITY\ANONYMOUS LOGON' may appear. Either install the PowerShell provider for BizTalk on all machines that run the BizTalk database, or install it on the machine the runs Deployit and use an overthere.LocalHost to access it.
    • PowerShell 2.0 must be installed.
    • The 32-bit version of the PowerShell executable must be configured to run with .NET 4.0 (see below).
    • The BizTalkFactory PowerShell Provider for BizTalk Server 2010 must be installed.

Configure the 32-bit version of PowerShell to run with .NET 4.0

On the machine that runs the PowerShell provider for BizTalk, create the file C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe.config with the following content:

 <?xml version="1.0"?> 
 <configuration> 
     <startup useLegacyV2RuntimeActivationPolicy="true"> 
         <supportedRuntime version="v4.0.30319"/> 
         <supportedRuntime version="v2.0.50727"/> 
    </startup> 
</configuration>

Usage in deployment packages

The plugin works with the standard deployment package DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one. The following is a sample MANIFEST.MF file that includes a few of the deployables provided by the BizTalk plugin:

Manifest-Version: 1.0
Deployit-Package-Format-Version: 1.3
CI-Application: BizTalkApp1
CI-Version: 1.0

Name: BizTalkApp1
CI-Type: biztalk.ApplicationSpec

Name: BizTalkApp1.Schemas.dll
CI-Type: biztalk.BizTalkAssemblyFile
CI-applicationName: BizTalkApp1
CI-destinationPath: {{ASSEMBLY_DESTINATION_DIR}}\BizTalkApp1.Sche
 mas.dll

Name: BizTalkApp1.dll
CI-Type: biztalk.BizTalkAssemblyFile
CI-applicationName: BizTalkApp1
CI-destinationPath: {{ASSEMBLY_DESTINATION_DIR}}\BizTalkApp1.dll

Name: BizTalkApp1.BindingInfo.xml
CI-Type: biztalk.BindingsFile
CI-applicationName: BizTalkApp1

Name: BizTalkApp1.1.0.Vocabulary.xml
CI-Type: biztalk.VocabularyFile
CI-applicationName: All policies

Name: BizTalkApp1.Rule.1.0.xml
CI-Type: biztalk.RulesFile
CI-applicationName: All policies

Using the deployables and deployeds

The following table describes which deployable/container combinations are possible.

Deployable vs. Container table

Deployable Container Generated deployed
biztalk.ApplicationSpec biztalk.Database biztalk.Application
biztalk.AssemblyFile biztalk.Database biztalk.Assembly
biztalk.AssemblyFile biztalk.Server biztalk.InstalledAssembly
biztalk.BindingsFile biztalk.Database biztalk.Bindings
biztalk.BizTalkAssemblyFile biztalk.Database biztalk.BizTalkAssembly
biztalk.BizTalkAssemblyFile biztalk.Server biztalk.InstalledAssembly
biztalk.RulesFile biztalk.Database biztalk.Rules
biztalk.VocabularyFile biztalk.Database biztalk.Vocabulary

The following table describes the effect a deployed has on its container

Deployed Actions Table

Deployed Actions performed for operations
  Create Destroy Modify
biztalk.Application
  1. Create BizTalk application
  2. Start BizTalk application
  1. Stop BizTalk application
  2. Destroy BizTalk application
  1. Stop BizTalk application
  2. Destroy BizTalk application
  3. Create BizTalk application
  4. Start BizTalk application
biztalk.Assembly
  1. Add plain assembly
  1. Remove plain assembly
  1. Remove plain assembly
  2. Add plain assembly
biztalk.Bidings
  1. Import BizTalk bindings
 
  1. Import BizTalk bindings
biztalk.BizTalkAssembly
  1. Add BizTalk assembly
  1. Remove BizTalk assembly
  1. Remove BizTalk assembly
  2. Add BizTalk assembly
biztalk.InstalledAssembly
  1. Install assembly into GAC
 
  1. Install assembly into GAC
biztalk.Rules
  1. Import and deploy BRE rules
  1. Undeploy BRE rules
  1. Undeploy BRE rules
  2. Import and deploy BRE rules
biztalk.Vocabulary
  1. Import BRE vocabulary
 
  1. Import BRE vocabulary

Extending the BizTalk plugin

The BizTalk plugin has been written upon the foundations provided by the PowerShell plugin, which is a standard part of the Deployit server distribution. Please refer to the documentation of the PowerShell plugin for details on how to extend PowerShell-based plugins.

CI Reference

Configuration Item Overview

Deployables

CI Description
biztalk.ApplicationSpec Specification for a BizTalk application
biztalk.AssemblyFile Assembly file (DLL)
biztalk.BaseAssemblyFile Base class for (BizTalk) assembly file (DLL)
biztalk.BindingsFile BizTalk bindings file (XML)
biztalk.BizTalkAssemblyFile BizTalk assembly file (DLL)
biztalk.RulesFile BizTalk BRE rules file (XML)
biztalk.VocabularyFile BizTalk BRE vocabulary file (XML)

Deployeds

CI Description
biztalk.Application BizTalk application
biztalk.Assembly Registered assembly
biztalk.BaseAssembly Base class for registered (BizTalk) assembly
biztalk.Bindings BizTalk bindings
biztalk.BizTalkAssembly Registered BizTalk assembly
biztalk.InstalledAssembly Installed (BizTalk) assembly
biztalk.Rules BizTalk BRE rules
biztalk.Vocabulary BizTalk BRE vocabulary

Containers

CI Description
biztalk.Database BizTalk database
biztalk.Server BizTalk server

Other Configuration Items

CI Description
biztalk.Application BizTalk application
biztalk.ApplicationSpec Specification for a BizTalk application
biztalk.Assembly Registered assembly
biztalk.AssemblyFile Assembly file (DLL)
biztalk.BaseAssembly Base class for registered (BizTalk) assembly
biztalk.BaseAssemblyFile Base class for (BizTalk) assembly file (DLL)
biztalk.Bindings BizTalk bindings
biztalk.BindingsFile BizTalk bindings file (XML)
biztalk.BizTalkAssembly Registered BizTalk assembly
biztalk.BizTalkAssemblyFile BizTalk assembly file (DLL)
biztalk.Database BizTalk database
biztalk.InstalledAssembly Installed (BizTalk) assembly
biztalk.Rules BizTalk BRE rules
biztalk.RulesFile BizTalk BRE rules file (XML)
biztalk.Server BizTalk server
biztalk.Vocabulary BizTalk BRE vocabulary
biztalk.VocabularyFile BizTalk BRE vocabulary file (XML)

Configuration Item Details

biztalk.Application

Type Hierarchy powershell.ExtensiblePowerShellDeployed >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Deployed, udm.ConfigurationItem

BizTalk application

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Name of this application. Defaults to the name of the deployed if not specified
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, this application is stopped and started when another component in the same package is deployed
Hidden Properties
 
 
createOrder : INTEGER  = 56
Create Order
 
 
createScript : STRING  = biztalk/create-application.ps1
Create Script
 
 
createVerb : STRING  = Create
Verb that is used to prefix a step description for the create operation.
 
 
destroyOrder : INTEGER  = 44
Destroy Order
 
 
destroyScript : STRING  = biztalk/destroy-application.ps1
Destroy Script
 
 
destroyVerb : STRING  = Destroy
Verb that is used to prefix a step description for the destroy operation.
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startScript : STRING  = biztalk/start-application.ps1
Start Script
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopScript : STRING  = biztalk/stop-application.ps1
Stop Script
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.

biztalk.ApplicationSpec

Type Hierarchy powershell.BasePowerShellDeployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a BizTalk application

Public Properties
 
 
applicationName : STRING
Name of this application. Defaults to the name of the deployed if not specified (string)
 
 
stopStartOnNoop : STRING
If set to true, this application is stopped and started when another component in the same package is deployed (boolean)
 
 
tags : SET_OF_STRING
If set, this deployable will only be mapped automatically to containers with the same tag.

biztalk.Assembly

Type Hierarchy biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Registered assembly

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
destinationPath : STRING
Destination Path
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
gacOnAdd : BOOLEAN
Add to the global assembly cache on add resource (gacutil)
 
 
gacOnImport : BOOLEAN
Add to the global assembly cache on MSI file import (gacutil)
 
 
gacOnInstall : BOOLEAN
Add to the global assembly cache on MSI file install (gacutil)
 
 
overwrite : BOOLEAN
Overwrite
 
 
placeholders : MAP_STRING_STRING
A Map containing all the placeholders mapped to their values. Special values are or
 
 
regAsm : BOOLEAN
Make visible to COM components (regasm)
 
 
regSvcs : BOOLEAN
Register serviced components (regsvcs)
 
 
sourcePath : STRING
Source Path
Hidden Properties
 
 
assemblyType : STRING  = System.BizTalk:Assembly
Assembly Type
 
 
createOrder : INTEGER  = 58
Create Order
 
 
createScript : STRING  = biztalk/add-assembly.ps1
Create Script
 
 
createVerb : STRING  = Add
Create Verb
 
 
destroyOrder : INTEGER  = 42
Destroy Order
 
 
destroyScript : STRING  = biztalk/remove-assembly.ps1
Destroy Script
 
 
destroyVerb : STRING  = Remove
Destroy Verb
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.AssemblyFile

Type Hierarchy biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Assembly file (DLL)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
destinationPath : STRING
Destination Path (string)
 
 
excludeFileNamesRegex : STRING
Regular expression that matches file names that must be excluded from scanning
 
 
gacOnAdd : STRING
Add to the global assembly cache on add resource (gacutil) (boolean)
 
 
gacOnImport : STRING
Add to the global assembly cache on MSI file import (gacutil) (boolean)
 
 
gacOnInstall : STRING
Add to the global assembly cache on MSI file install (gacutil) (boolean)
 
 
overwrite : STRING
Overwrite (boolean)
 
 
placeholders : SET_OF_STRING
Placeholders detected in this artifact
 
 
regAsm : STRING
Make visible to COM components (regasm) (boolean)
 
 
regSvcs : STRING
Register serviced components (regsvcs) (boolean)
 
 
scanPlaceholders : BOOLEAN  = true
Whether to scan this artifact for placeholders when it is imported
 
 
sourcePath : STRING
Source Path (string)
 
 
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

biztalk.BaseAssembly

Virtual Type
Type Hierarchy powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Base class for registered (BizTalk) assembly

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
destinationPath : STRING
Destination Path
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
gacOnAdd : BOOLEAN
Add to the global assembly cache on add resource (gacutil)
 
 
gacOnImport : BOOLEAN
Add to the global assembly cache on MSI file import (gacutil)
 
 
gacOnInstall : BOOLEAN
Add to the global assembly cache on MSI file install (gacutil)
 
 
overwrite : BOOLEAN
Overwrite
 
 
placeholders : MAP_STRING_STRING
A Map containing all the placeholders mapped to their values. Special values are or
 
 
sourcePath : STRING
Source Path
Hidden Properties
 
 
createOrder : INTEGER  = 58
Create Order
 
 
createScript : STRING  = biztalk/add-assembly.ps1
Create Script
 
 
createVerb : STRING  = Add
Create Verb
 
 
destroyOrder : INTEGER  = 42
Destroy Order
 
 
destroyScript : STRING  = biztalk/remove-assembly.ps1
Destroy Script
 
 
destroyVerb : STRING  = Remove
Destroy Verb
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.BaseAssemblyFile

Type Hierarchy powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Base class for (BizTalk) assembly file (DLL)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
destinationPath : STRING
Destination Path (string)
 
 
excludeFileNamesRegex : STRING
Regular expression that matches file names that must be excluded from scanning
 
 
gacOnAdd : STRING
Add to the global assembly cache on add resource (gacutil) (boolean)
 
 
gacOnImport : STRING
Add to the global assembly cache on MSI file import (gacutil) (boolean)
 
 
gacOnInstall : STRING
Add to the global assembly cache on MSI file install (gacutil) (boolean)
 
 
overwrite : STRING
Overwrite (boolean)
 
 
placeholders : SET_OF_STRING
Placeholders detected in this artifact
 
 
scanPlaceholders : BOOLEAN  = true
Whether to scan this artifact for placeholders when it is imported
 
 
sourcePath : STRING
Source Path (string)
 
 
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

biztalk.Bindings

Type Hierarchy powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

BizTalk bindings

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
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 or
Hidden Properties
 
 
createOrder : INTEGER  = 60
Order in which a create step will be executed.
 
 
createScript : STRING  = biztalk/import-bindings.ps1
Create Script
 
 
createVerb : STRING  = Import
Create Verb
 
 
destroyOrder : INTEGER  = 40
Order in which a destroy step will be executed.
 
 
destroyVerb : STRING  = Destroy
Verb that is used to prefix a step description for the destroy operation.
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
destroyScript : STRING
PowerShell script invoked to undeploy an artifact or a resource on Windows.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.BindingsFile

Type Hierarchy powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

BizTalk bindings file (XML)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
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

biztalk.BizTalkAssembly

Type Hierarchy biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Registered BizTalk assembly

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
destinationPath : STRING
Destination Path
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
gacOnAdd : BOOLEAN
Add to the global assembly cache on add resource (gacutil)
 
 
gacOnImport : BOOLEAN
Add to the global assembly cache on MSI file import (gacutil)
 
 
gacOnInstall : BOOLEAN
Add to the global assembly cache on MSI file install (gacutil)
 
 
overwrite : BOOLEAN
Overwrite
 
 
placeholders : MAP_STRING_STRING
A Map containing all the placeholders mapped to their values. Special values are or
 
 
sourcePath : STRING
Source Path
Hidden Properties
 
 
assemblyType : STRING  = System.BizTalk:BizTalkAssembly
Assembly Type
 
 
createOrder : INTEGER  = 58
Create Order
 
 
createScript : STRING  = biztalk/add-assembly.ps1
Create Script
 
 
createVerb : STRING  = Add
Create Verb
 
 
destroyOrder : INTEGER  = 42
Destroy Order
 
 
destroyScript : STRING  = biztalk/remove-assembly.ps1
Destroy Script
 
 
destroyVerb : STRING  = Remove
Destroy Verb
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.BizTalkAssemblyFile

Type Hierarchy biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

BizTalk assembly file (DLL)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
destinationPath : STRING
Destination Path (string)
 
 
excludeFileNamesRegex : STRING
Regular expression that matches file names that must be excluded from scanning
 
 
gacOnAdd : STRING
Add to the global assembly cache on add resource (gacutil) (boolean)
 
 
gacOnImport : STRING
Add to the global assembly cache on MSI file import (gacutil) (boolean)
 
 
gacOnInstall : STRING
Add to the global assembly cache on MSI file install (gacutil) (boolean)
 
 
overwrite : STRING
Overwrite (boolean)
 
 
placeholders : SET_OF_STRING
Placeholders detected in this artifact
 
 
scanPlaceholders : BOOLEAN  = true
Whether to scan this artifact for placeholders when it is imported
 
 
sourcePath : STRING
Source Path (string)
 
 
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

biztalk.Database

Type Hierarchy powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, powershell.PowerShellContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

BizTalk database

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
databaseName : STRING  = BizTalkMgmtDb
Database Name
 
 
instanceName : STRING
Instance Name
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
Hidden Properties
 
 
powerShellPath : STRING  = C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
Power Shell Path
 
 
runtimePath : STRING  = biztalk/runtime
Runtime Path

biztalk.InstalledAssembly

Type Hierarchy powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Installed (BizTalk) assembly

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 or
Hidden Properties
 
 
createOrder : INTEGER  = 59
Create Order
 
 
createScript : STRING  = biztalk/install-assembly.ps1
Create Script
 
 
createVerb : STRING  = Install
Create Verb
 
 
destroyOrder : INTEGER  = 40
Order in which a destroy step will be executed.
 
 
destroyVerb : STRING  = Destroy
Verb that is used to prefix a step description for the destroy operation.
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
destroyScript : STRING
PowerShell script invoked to undeploy an artifact or a resource on Windows.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.Rules

Type Hierarchy powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

BizTalk BRE rules

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
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 or
Hidden Properties
 
 
createOrder : INTEGER  = 60
Order in which a create step will be executed.
 
 
createScript : STRING  = biztalk/import-and-deploy-rules.ps1
Create Script
 
 
createVerb : STRING  = Import and deploy
Create Verb
 
 
destroyOrder : INTEGER  = 40
Order in which a destroy step will be executed.
 
 
destroyScript : STRING  = biztalk/undeploy-rules.ps1
Destroy Script
 
 
destroyVerb : STRING  = Undeploy
Destroy Verb
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.RulesFile

Type Hierarchy powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

BizTalk BRE rules file (XML)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
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

biztalk.Server

Type Hierarchy powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, powershell.PowerShellContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

BizTalk server

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
Hidden Properties
 
 
powerShellPath : STRING  = C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
Power Shell Path
 
 
runtimePath : STRING
Runtime path for this container

biztalk.Vocabulary

Type Hierarchy powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

BizTalk BRE vocabulary

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
applicationName : STRING
Application Name
 
 
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 or
Hidden Properties
 
 
createOrder : INTEGER  = 58
Create Order
 
 
createScript : STRING  = biztalk/import-vocabulary.ps1
Create Script
 
 
createVerb : STRING  = Import
Create Verb
 
 
destroyOrder : INTEGER  = 40
Order in which a destroy step will be executed.
 
 
destroyVerb : STRING  = Destroy
Verb that is used to prefix a step description for the destroy operation.
 
 
modifyOrder : INTEGER  = 60
Order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
Verb that is used to prefix a step description for the modify operation.
 
 
noopOrder : INTEGER  = 50
Order in which a noop step will be executed.
 
 
noopVerb : STRING  = Noop
Verb that is used to prefix a step description for the noop operation.
 
 
startOrder : INTEGER  = 90
Order in which a start step will be executed.
 
 
startVerb : STRING  = Start
Verb that is used to prefix a step description for the start operation.
 
 
stopOrder : INTEGER  = 10
Order in which a synchronize after modify stop will be executed.
 
 
stopVerb : STRING  = Stop
Verb that is used to prefix a step description for the stop operation.
 
 
destroyScript : STRING
PowerShell script invoked to undeploy an artifact or a resource on Windows.
 
 
exposeDeployedApplication : BOOLEAN  = false
If set to true, the deployed application CI is exposed to the PowerShell script.
 
 
modifyScript : STRING
PowerShell script invoked to upgrade an artifact or a resource on Windows.
 
 
noopScript : STRING
PowerShell script invoked to noop an artifact or a resource on Windows.
 
 
startScript : STRING
PowerShell script invoked to start an artifact or resource on Windows.
 
 
stopScript : STRING
PowerShell script invoked to stop an artifact or resource on Windows.
 
 
stopStartOnNoop : BOOLEAN  = false
If set to true, the stop and start operations will be executed for the noop operation.

biztalk.VocabularyFile

Type Hierarchy powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

BizTalk BRE vocabulary file (XML)

Public Properties
 
 
applicationName : STRING
Application Name (string)
 
 
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