BizTalk Plugin Reference
The XL Deploy BizTalk plugin adds the capability to perform BizTalk configuration and deployment tasks.
This document provides information that is specific to this version of the BizTalk plugin. For general information about the plugin, refer to Introduction to the XL Deploy BizTalk plugin.
Requirements
- XL Deploy 5.1.0 or later
- BizTalk Server 2006 R2, 2009, 2010, or 2013
- Requirements on the target machine:
- Administrative access (with elevated privileges) is required to run the PowerShell provider for BizTalk
- PowerShell 2.0 must be installed
- The 32-bit version of the PowerShell executable must be configured to run with .NET 4.0
- The BizTalkFactory PowerShell Provider version 1.2.0.x for BizTalk Server 2010 or version 1.3.0.x for BizTalk Server 2013 must be installed
Troubleshooting WinRM connections
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 XL Deploy and use an overthere.LocalHost
CI to access it.
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>
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible:
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 |
Deployed actions table
The following table describes the effect a deployed has on its container:
Deployed | Actions performed for operations | |||
---|---|---|---|---|
Create | Destroy | Modify | ||
biztalk.Application |
|
|
|
|
biztalk.Assembly |
|
|
|
|
biztalk.Bidings |
|
|
||
biztalk.BizTalkAssembly |
|
|
|
|
biztalk.InstalledAssembly |
|
|
||
biztalk.Rules |
|
|
|
|
biztalk.Vocabulary |
|
|
Release Notes
BizTalk plugin 6.0.1
XL Deploy 6.0.0 compatibility.
BizTalk plugin 6.0.0
XL Deploy 6.0.0 compatibility.
BizTalk plugin 5.1.0
Improvements
- [DEPL-8832] - Import BizTalk bindings again if the assembly is modified
- [DEPL-9438] - When an assembly is updated but not the associated application, stop and start the BizTalk application
Bug fixes
- [DEPL-9450] - Importing/publishing/deploying vocabularies and rules fails with a "You cannot call a method on a null-valued expression." error
BizTalk plugin 5.0.1
Improvements
- [DEPL-8832] - Import BizTalk bindings again if the assembly is modified
- [DEPL-9438] - When an assembly is updated but not the associated application, stop and start the BizTalk application
Bug fixes
- [DEPL-9450] - Importing/publishing/deploying vocabularies and rules fails with a "You cannot call a method on a null-valued expression." error
BizTalk plugin 5.0.0
XL Deploy 5.0.0 compatibility.
BizTalk plugin 4.0.0
New features
- [DEPL-5658] - Add support for BizTalk Server 2013
Improvements
- [DEPL-5220] - BizTalk assemblies are not copied to the
biztalk.Server
file system
BizTalk plugin 3.9.2
New features
- [DEPL-5184] - Add support for setting BizTalk application references
BizTalk plugin 3.9.1
Bug fixes
- [DEPLOYITPB-4863] - Deployment of rules and vocabularies does not work properly from a remote machine.
BizTalk plugin 3.9.0
Bug fixes
- [DEPLOYITPB-4297] - Retrieving full assembly name from the assembly file when removing the assembly.
BizTalk plugin 3.8.0
New features
- Initial release of BizTalk plugin for BizTalk Server 2010.
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.BizTalkMapAssemblyFile | BizTalk Map assembly file (DLL) |
biztalk.BizTalkOrchestrationAssemblyFile | BizTalk Orchestration assembly file (DLL) |
biztalk.BizTalkPipelineAssemblyFile | BizTalk Pipeline assembly file (DLL) |
biztalk.BizTalkSchemaAssemblyFile | BizTalk Schema 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.BizTalkMapAssembly | Registered BizTalk Map assembly |
biztalk.BizTalkOrchestrationAssembly | Registered BizTalk Orchestration assembly |
biztalk.BizTalkPipelineAssembly | Registered BizTalk Pipeline assembly |
biztalk.BizTalkSchemaAssembly | Registered BizTalk Schema 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.BizTalkMapAssembly | Registered BizTalk Map assembly |
biztalk.BizTalkMapAssemblyFile | BizTalk Map assembly file (DLL) |
biztalk.BizTalkOrchestrationAssembly | Registered BizTalk Orchestration assembly |
biztalk.BizTalkOrchestrationAssemblyFile | BizTalk Orchestration assembly file (DLL) |
biztalk.BizTalkPipelineAssembly | Registered BizTalk Pipeline assembly |
biztalk.BizTalkPipelineAssemblyFile | BizTalk Pipeline assembly file (DLL) |
biztalk.BizTalkSchemaAssembly | Registered BizTalk Schema assembly |
biztalk.BizTalkSchemaAssemblyFile | BizTalk Schema 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.EmbeddedDeployedContainer, 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
|
||
|
|
applicationReferences
:
SET_OF_STRING
|
Name(s) of the application(s) the currently deployed application should have a reference to
|
||
|
|
deployable
:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
If set to true, this application is stopped and started when another component in the same package is deployed
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 50
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/create-or-modify-application.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Create
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 50
|
Order at which the destroy step will be executed.
|
||
|
|
destroyScript
:
STRING
= biztalk/destroy-application.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Delete
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 50
|
Order at which the modify step will be executed.
|
||
|
|
modifyScript
:
STRING
= biztalk/create-or-modify-application.ps1
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startScript
:
STRING
= biztalk/start-application.ps1
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopScript
:
STRING
= biztalk/stop-application.ps1
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
biztalk.ApplicationSpec
Type Hierarchy | powershell.BasePowerShellDeployable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a BizTalk application
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Name of this application. Defaults to the name of the deployed if not specified (string)
|
||
|
|
applicationReferences
:
SET_OF_STRING
|
Name(s) of the application(s) the currently deployed application should have a reference to (set_of_string)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, this application is stopped and started when another component in the same package is deployed (boolean) default(false)
|
||
|
|
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.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
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
|
||
|
|
regAsm
:
BOOLEAN
|
Make visible to COM components (regasm)
|
||
|
|
regSvcs
:
BOOLEAN
|
Register serviced components (regsvcs)
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
assemblyType
:
STRING
= System.BizTalk:Assembly
|
Assembly Type
|
||
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 51
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 49
|
Order at which the destroy step will be executed.
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.AssemblyFile
Type Hierarchy | biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
Assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BaseAssembly
Virtual Type | |
---|---|
Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 51
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 49
|
Order at which the destroy step will be executed.
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BaseAssemblyFile
Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
Base class for (BizTalk) assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.Bindings
Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
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
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 60
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/import-bindings.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Import
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 40
|
Order at which the destroy step will be executed.
|
||
|
|
destroyVerb
:
STRING
= Destroy
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
destroyScript
:
STRING
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BindingsFile
Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk bindings file (XML)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
placeholders
:
SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
scanPlaceholders
:
BOOLEAN
= true
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BizTalkAssembly
Type Hierarchy | biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Registered BizTalk assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name
|
||
|
|
createOrder
:
INTEGER
= 52
|
Should be within the range of 50-60
|
||
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
destroyOrder
:
INTEGER
= 48
|
Should be within the range of 40-50
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BizTalkAssemblyFile
Type Hierarchy | biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createOrder
:
STRING
|
Should be within the range of 50-60 (integer) default(52)
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
destroyOrder
:
STRING
|
Should be within the range of 40-50 (integer) default(48)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BizTalkMapAssembly
Type Hierarchy | biztalk.BizTalkAssembly >> biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Registered BizTalk Map assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name
|
||
|
|
createOrder
:
INTEGER
= 57
|
Should be within the range of 57-58
|
||
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
destroyOrder
:
INTEGER
= 42
|
Should be within the range of 42-43
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BizTalkMapAssemblyFile
Type Hierarchy | biztalk.BizTalkAssemblyFile >> biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk Map assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createOrder
:
STRING
|
Should be within the range of 57-58 (integer) default(57)
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
destroyOrder
:
STRING
|
Should be within the range of 42-43 (integer) default(42)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BizTalkOrchestrationAssembly
Type Hierarchy | biztalk.BizTalkAssembly >> biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Registered BizTalk Orchestration assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name
|
||
|
|
createOrder
:
INTEGER
= 59
|
Should be within the range of 59-60
|
||
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
destroyOrder
:
INTEGER
= 40
|
Should be within the range of 40-41
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BizTalkOrchestrationAssemblyFile
Type Hierarchy | biztalk.BizTalkAssemblyFile >> biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk Orchestration assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createOrder
:
STRING
|
Should be within the range of 59-60 (integer) default(59)
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
destroyOrder
:
STRING
|
Should be within the range of 40-41 (integer) default(40)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BizTalkPipelineAssembly
Type Hierarchy | biztalk.BizTalkAssembly >> biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Registered BizTalk Pipeline assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name
|
||
|
|
createOrder
:
INTEGER
= 55
|
Should be within the range of 55-56
|
||
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
destroyOrder
:
INTEGER
= 44
|
Should be within the range of 44-45
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BizTalkPipelineAssemblyFile
Type Hierarchy | biztalk.BizTalkAssemblyFile >> biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk Pipeline assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createOrder
:
STRING
|
Should be within the range of 55-56 (integer) default(55)
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
destroyOrder
:
STRING
|
Should be within the range of 44-45 (integer) default(44)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.BizTalkSchemaAssembly
Type Hierarchy | biztalk.BizTalkAssembly >> biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Registered BizTalk Schema assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name
|
||
|
|
createOrder
:
INTEGER
= 53
|
Should be within the range of 53-54
|
||
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
destroyOrder
:
INTEGER
= 46
|
Should be within the range of 46-47
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Add
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Remove
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.BizTalkSchemaAssemblyFile
Type Hierarchy | biztalk.BizTalkAssemblyFile >> biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk Schema assembly file (DLL)
Public Properties | ||
---|---|---|
|
|
applicationName
:
STRING
|
Application Name (string)
|
||
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createOrder
:
STRING
|
Should be within the range of 53-54 (integer) default(53)
|
||
|
|
destinationPath
:
STRING
|
Destination Path (string)
|
||
|
|
destroyOrder
:
STRING
|
Should be within the range of 46-47 (integer) default(46)
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
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)
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.Database
Type Hierarchy | powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, powershell.PowerShellContainer |
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 | ||
---|---|---|
|
|
discoverOrder
:
INTEGER
= 0
|
Order at which the discover step will be executed.
|
||
|
|
powerShellPath
:
STRING
= C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
|
Power Shell Path
|
||
|
|
runtimePath
:
STRING
= biztalk/runtime
|
Runtime Path
|
||
|
|
deployedsToDiscover
:
SET_OF_STRING
|
Deployeds To Discover
|
||
|
|
discoverScript
:
STRING
|
Script invoked to inspect this container and discover deployeds on it.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
= [powershell/runtime/base.ps1]
|
List of scripts to append to the the step script.
|
biztalk.InstalledAssembly
Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Installed (BizTalk) assembly
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
destinationPath
:
STRING
|
Destination Path
|
||
|
|
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
|
||
|
|
sourcePath
:
STRING
|
Source Path
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 59
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/install-assembly.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Install
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 40
|
Order at which the destroy step will be executed.
|
||
|
|
destroyVerb
:
STRING
= Destroy
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
destroyScript
:
STRING
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.Rules
Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
BizTalk BRE rules
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
majorVersion
:
STRING
|
Major version of the rule in the BizTalk Business Rule Engine
|
||
|
|
minorVersion
:
STRING
|
Minor version of the rule in the BizTalk Business Rule Engine
|
||
|
|
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
|
||
|
|
rulesName
:
STRING
|
Name of this rules object. Defaults to the name of the deployed if not specified
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 64
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/import-and-publish-and-deploy-rules.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Import, publish and deploy
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 36
|
Order at which the destroy step will be executed.
|
||
|
|
destroyScript
:
STRING
= biztalk/undeploy-and-delete-rules.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Undeploy and delete
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.RulesFile
Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk BRE rules file (XML)
Public Properties | ||
---|---|---|
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
majorVersion
:
STRING
|
Major version of the rule in the BizTalk Business Rule Engine (string)
|
||
|
|
minorVersion
:
STRING
|
Minor version of the rule in the BizTalk Business Rule Engine (string)
|
||
|
|
placeholders
:
SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
rulesName
:
STRING
|
Name of this rules object. Defaults to the name of the deployed if not specified (string)
|
||
|
|
scanPlaceholders
:
BOOLEAN
= true
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
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
|
biztalk.Server
Type Hierarchy | powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, powershell.PowerShellContainer |
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 | ||
---|---|---|
|
|
discoverOrder
:
INTEGER
= 0
|
Order at which the discover step will be executed.
|
||
|
|
powerShellPath
:
STRING
= C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
|
Power Shell Path
|
||
|
|
deployedsToDiscover
:
SET_OF_STRING
|
Deployeds To Discover
|
||
|
|
discoverScript
:
STRING
|
Script invoked to inspect this container and discover deployeds on it.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
= [powershell/runtime/base.ps1]
|
List of scripts to append to the the step script.
|
biztalk.Vocabulary
Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
BizTalk BRE vocabulary
Parent | ||
---|---|---|
|
|
container
:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public Properties | ||
---|---|---|
|
|
majorVersion
:
STRING
|
Major version of the vocabulary in the BizTalk Business Rule Engine
|
||
|
|
minorVersion
:
STRING
|
Minor version of the vocabulary in the BizTalk Business Rule Engine
|
||
|
|
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
|
||
|
|
startOnCreate
:
BOOLEAN
= true
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
stopOnDestroy
:
BOOLEAN
= true
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
stopStartOnModify
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
stopStartOnNoop
:
BOOLEAN
= true
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
||
|
|
vocabularyName
:
STRING
|
Name of this vocabulary. Defaults to the name of the deployed if not specified
|
Hidden Properties | ||
---|---|---|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder
:
INTEGER
= 62
|
Order at which the create step will be executed.
|
||
|
|
createScript
:
STRING
= biztalk/import-and-publish-vocabulary.ps1
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
createVerb
:
STRING
= Import and publish
|
Verb that is used to prefix the description for the create step.
|
||
|
|
destroyOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder
:
INTEGER
= 38
|
Order at which the destroy step will be executed.
|
||
|
|
destroyScript
:
STRING
= biztalk/delete-vocabulary.ps1
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
destroyVerb
:
STRING
= Delete
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
discoverOrder
:
INTEGER
= 50
|
Order at which the discover step will be executed.
|
||
|
|
maxBatchSize
:
INTEGER
= 100
|
Maximum number of steps in a batch.
|
||
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData, uploadClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder
:
INTEGER
= 60
|
Order at which the modify step will be executed.
|
||
|
|
modifyVerb
:
STRING
= Modify
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
noopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
noopOrder
:
INTEGER
= 50
|
Order at which the noop step will be executed.
|
||
|
|
noopVerb
:
STRING
= Noop
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
startOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
startOrder
:
INTEGER
= 90
|
Order at which the start step will be executed.
|
||
|
|
startVerb
:
STRING
= Start
|
Verb that is used to prefix the description for the start step.
|
||
|
|
stopOptions
:
SET_OF_STRING
= [uploadClasspathResources]
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
stopOrder
:
INTEGER
= 10
|
Order at which the stop script will be executed.
|
||
|
|
stopVerb
:
STRING
= Stop
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
batchSteps
:
BOOLEAN
= false
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
classpathResources
:
SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
discoverScript
:
STRING
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
libraryScripts
:
LIST_OF_STRING
|
List of scripts to append to the the step script.
|
||
|
|
modifyScript
:
STRING
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
noopScript
:
STRING
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
startScript
:
STRING
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
stopScript
:
STRING
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
biztalk.VocabularyFile
Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
BizTalk BRE vocabulary file (XML)
Public Properties | ||
---|---|---|
|
|
checksum
:
STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
excludeFileNamesRegex
:
STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri
:
STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
majorVersion
:
STRING
|
Major version of the vocabulary in the BizTalk Business Rule Engine (string)
|
||
|
|
minorVersion
:
STRING
|
Minor version of the vocabulary in the BizTalk Business Rule Engine (string)
|
||
|
|
placeholders
:
SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
scanPlaceholders
:
BOOLEAN
= true
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
startOnCreate
:
STRING
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
stopOnDestroy
:
STRING
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
stopStartOnModify
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
stopStartOnNoop
:
STRING
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
tags
:
SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
vocabularyName
:
STRING
|
Name of this vocabulary. Defaults to the name of the deployed if not specified (string)
|
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
|