/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

PowerShell Adapter

Properties   Configuration Settings  

Executes PowerShell scripts and returns the results.

Remarks

The PowerShell BizTalk Adapter is a BizTalk Server transmit adapter that will execute PowerShell scripts whenever BizTalk sends a message through it. This allows for easy creation of custom processing scripts for BizTalk messages that are completely integrated into your BizTalk solution.

Setting up the Adapter

To use the PowerShell BizTalk Adapter, it's necessary to do the following:

  1. Create a new Send Port in your BizTalk application
  2. Select the PowerShell BizTalk Adapter as the adapter to use in the port
  3. Configure the Adapter settings with the following:

    • A name that identifies this send port
    • The PowerShell script to execute when a message is sent; this can be the script itself or the dot-source for an external script file
    • Optionally, to pass additional input data to the script, fill in the Variables property; this should be a list of 'name=value' pairs, one per line, and each one will be visible in the PowerShell script as a variable called $name

Accessing the BizTalk Message

Detailed information about accessing BizTalk message properties can be found under the Script property.

Diagnosing Scripts

The Adapter provides an easy way for scripts to generate diagnostics data that can be used to troubleshoot their behavior, by providing ways for the scripts to write diagnostic messages directly to the Adapter log.

This is exposed to the script through the Write-Debug, Write-Warning and Write-Verbose cmdlets, or as an alternative, by calling the corresponding functions in $host.UI.

Executing Scripts on Remote Machines

Detailed information on remote execution can be found under the Host property.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

FirewallA set of properties related to firewall access.
HostThe host where the command should be executed.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordThe password to use when executing commands remotely.
PortThe TCP port number to use for remote connections.
PortNameA unique name assigned to this send port.
ProtocolThe protocol to use for executing remote commands.
ScriptThe PowerShell script to execute.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe username to use when executing commands remotely.
VariablesVariables to add to the PowerShell Runspace before executing the command.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

ReportScriptErrorWhether script errors cause a failure.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrintInstructs the adapter to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the signature algorithm when attempting public key authentication.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6824]