Microsoft BizTalk Server

https://learn.microsoft.com/en-us/biztalk/
Admin
Microsoft BizTalk Server provides an integration and connectivity platform to automate business...
Tokens:2,033,677
Snippets:30,793
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Execute BTSXRefImport with Setup File

Source: https://learn.microsoft.com/en-us/biztalk/core/technical-reference/biztalk-server-cross-reference-import-tool-btsxrefimport-exe

Example command to run the tool using a specific XML setup file named setupfile.xml.

```text
btsxrefimport –file=setupfile.xml  
```

--------------------------------

### BTAJDEOneWorldTrace Usage Examples

Source: https://learn.microsoft.com/en-us/biztalk/core/using-event-tracing-for-windows2

Practical examples for starting a real-time transmitter trace and stopping the trace session.

```cmd
BTAJDEOneWorldTrace -transmitter -start -cir 10 -rt c:\log\mylog.etl  
BTAJDEOneWorldTrace -transmitter -stop  
```

--------------------------------

### BTAJDEEnterpriseOneTrace Usage Example

Source: https://learn.microsoft.com/en-us/biztalk/core/using-event-tracing-for-windows4

Example commands for starting a transmitter trace in real-time mode and stopping the trace.

```cmd
BTAJDEEnterpriseOneTrace -transmitter -start -cir 10 -rt c:\log\mylog.etl  
BTAJDEEnterpriseOneTrace -transmitter -stop
```

--------------------------------

### SetConfigInfo Example

Source: https://learn.microsoft.com/en-us/biztalk/core/technical-reference/issoconfigstore-setconfiginfo

A placeholder example showing the parameters used with the ConfigStore.

```C#
ConfigStore  
bstrApplication  
bstrIdentifier  
ppbConfigInfo
```

--------------------------------

### Display command line installation options

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/wcf-lob-adapter-sdk/install-the-wcf-lob-adapter-sdk

Use this command to view all available installation parameters for the MSI installer.

```shell
AdapterFramework.msi /?
```

--------------------------------

### Execute the Itinerary On-Ramp setup script

Source: https://learn.microsoft.com/en-us/biztalk/esb-toolkit/install-the-itinerary-on-ramp-sample-using-the-install-scripts

Run this command in a command prompt to initiate the installation, ensuring the path is replaced with the actual location of the .cmd file.

```batch
<path>\Setup_bin.cmd
```

--------------------------------

### Map and Install Host Instance via VBScript

Source: https://learn.microsoft.com/en-us/biztalk/core/technical-reference/mapping-and-installing-host-instances-using-wmi

Uses MSBTS_ServerHost to map a host to a server and MSBTS_HostInstance to install the instance. Requires appropriate credentials for the Install method.

```VBScript
Option Explicit  
  
' Map and install a host instance using MSBTS_ServerHost and MSBTS_HostInstance  
Sub MapInstallHostInstance (HostName, ServerName, uid, pwd)  
   On Error Resume Next  
  
   Dim objLocator, objService, objServerHost, objSH  
   Dim objHostInstance, objHI  
  
   ' Connects to local server WMI Provider BizTalk namespace  
   Set objLocator = Createobject ("wbemScripting.SWbemLocator")  
   Set objService = objLocator.ConnectServer(".", "root/MicrosoftBizTalkServer")  
  
   ' Step 1 - Create mapping between server and host using MSBTS_ServerHost class  
   Set objServerHost = objService.Get ("MSBTS_ServerHost")  
  
   Set objSH = objServerHost.SpawnInstance_  
  
   objSH.HostName = HostName  
   objSH.ServerName = ServerName  
  
   ' Invoke MSBTS_ServerHost Map method  
   objSH.Map  
  
   CheckWMIError  
   wscript.echo "Host - " & HostName & " - has been mapped successfully to server - " & ServerName  
  
   ' Step 2 - Install the host instance using MSBTS_HostInstance class  
   Set objHostInstance = objService.Get ("MSBTS_HostInstance")  
  
   Set objHI = objHostInstance.SpawnInstance_  
  
   objHI.Name = "Microsoft BizTalk Server " & HostName & " " & ServerName  
  
   ' Invoke MSBTS_HostInstance Install method  
   objHI.Install uid, pwd, true   ' Calling MSBTS_HostInstance::Install(string Logon, string Password, boolean GrantLogOnAsService) method  
  
   CheckWMIError  
   wscript.echo "HostInstance - " & HostName & " - has been installed successfully on server - " & ServerName  
  
end Sub  
  
'This subroutine deals with all errors using the WbemScripting object.  Error descriptions  
'are returned to the user by printing to the console.  
Sub   CheckWMIError()  
  
   If Err <> 0   Then  
      On Error Resume   Next  
  
      Dim strErrDesc: strErrDesc = Err.Description  
      Dim ErrNum: ErrNum = Err.Number  
      Dim WMIError : Set WMIError = CreateObject("WbemScripting.SwbemLastError")  
  
      If ( TypeName(WMIError) = "Empty" ) Then  
         wscript.echo strErrDesc & " (HRESULT: "   & Hex(ErrNum) & ")."  
      Else  
         wscript.echo WMIError.Description & "(HRESULT: " & Hex(ErrNum) & ")."  
         Set WMIError = nothing  
      End   If  
  
      wscript.quit 0  
   End If  
  
End Sub
```

--------------------------------

### setup-databases Command Examples

Source: https://learn.microsoft.com/en-us/biztalk/core/database-commands

Basic usage of the setup-databases command with a configuration file, and an example including a notification service user.

```bash
bm.exe setup-databases -ConfigFile:BamConfiguration.xml  
bm.exe setup-databases -ConfigFile:cfg.xml -NSUser:domain\user1
```

--------------------------------

### Execute PowerShell Script Example

Source: https://learn.microsoft.com/en-us/biztalk/core/applicationmanager-biztalk-server-sample

Example command to invoke the PowerShell script for starting a deployed application.

```powershell
PS C:\> .\ApplicationManager.ps1 start MyBizTalkApp

Issuing start command to MyBizTalkApp ...

```

--------------------------------

### SQL Server Connection Examples

Source: https://learn.microsoft.com/en-us/biztalk/core/addapp-command

Examples of specifying the SQL Server instance for the /Server parameter.

```text
Server=MyServer

Server=MyServer\MySQLServer,1533
```

--------------------------------

### HTTP GET Request with LocationID

Source: https://learn.microsoft.com/en-us/biztalk/core/http-receive-adapter

Example of an HTTP GET request targeting a specific location ID.

```http
http://servername/vroot/BTSHTTPReceive.dll?LocationID=1  
```

--------------------------------

### EXEC Statement Examples

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/adapter-siebel/syntax-for-an-exec-statement-in-siebel

Examples demonstrating various parameter configurations including named, unnamed, and output parameters.

```text
EXEC ExtractDataService.Echo @In, @InOut, @Out OUTPUT  
  
EXEC ExtractDataService.Echo 'InputValue', @InOut, @Out OUTPUT  
  
EXEC ExtractDataService.Echo @InOut, @Out OUTPUT, @In='InputValue'  
  
EXEC ExtractDataService.Echo 'InputValue', @Out OUTPUT, @InOut='InputValue'  
```

--------------------------------

### Full tRFC Client Example

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/adapter-sap/invoke-trfcs-in-sap-using-the-wcf-service-model

A complete example demonstrating the setup and structure for invoking BAPI_SALESORDER_CREATE as a tRFC.

```csharp
using System;  
using System.Collections.Generic;  
using System.Text;  
  
// Add WCF, the WCF LOB Adapter SDK, and SAP adapter namepaces  
using System.ServiceModel;  
using Microsoft.Adapters.SAP;  
using Microsoft.ServiceModel.Channels;  
  
// Include this namespace for WCF LOB Adapter SDK and SAP exceptions  
using Microsoft.ServiceModel.Channels.Common;  
  
using microsoft.lobservices.sap._2007._03.Types.Rfc;  
  
// This example demonstrates sending BAPI_SALESORDER_CREATEFROMDAT2 as a tRFC. The client has   
// methods to:  
//      send the BAPI (BAPI_SALESORDER_CREATEFROMDAT2)and to  
//      Confirm the transaction (RfcConfirmTransID)  
// An instance of BAPI_SALESORDER_CREATEFROMDAT2Request (generated)   
// is used to format the BAPI before invoking BAPI_SALESORDER_CREATEFROMDAT2. This   
// is not necessary, but is done to make it easier to read the code.  
// tRFC invocations always includes a ref parameter that contains a GUID. You can optionally   
// set this parameter when you invoke the method; however, you must use the value returned by  
// the adapter when you call RfcConfirmTransID to confirm the transaction on the SAP system.   
// You can call the utility method, SAPAdapterUtilities.ConvertGuidToTid, to get the value  
// of the SAP transaction Id from the GUID that the adapter returns.  
namespace SapTrfcClientSM  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            TrfcClient sapTrfcClient = null;  
  
            try  
            {  
                Console.WriteLine("SAP TRFC client sample started");  
                Console.WriteLine("Creating the TRFC client");  
```

--------------------------------

### BTATIBCOEMSTrace Usage Example

Source: https://learn.microsoft.com/en-us/biztalk/core/using-event-tracing-for-windows3

Example commands to start a real-time circular trace for the transmitter provider and subsequently stop it.

```cmd
BTATIBCOEMSTrace -transmitter -start -cir 10 -rt c:\log\mylog.etl  
BTATIBCOEMSTrace -transmitter -stop  
```

--------------------------------

### Run Enlist Orchestration Sample

Source: https://learn.microsoft.com/en-us/biztalk/core/enlist-orchestration-biztalk-server-sample

Command-line examples for executing the VBScript and C# versions of the orchestration enlistment tool.

```bash
cscript EnlistOrch.vbs MyBusinessOrchestration "My Business Assembly"
```

```bash
EnlistOrc MyBusinessOrchestration "My Business Assembly"
```

--------------------------------

### SetupComplete.cmd Script

Source: https://learn.microsoft.com/en-us/biztalk/core/sysprep-a-biztalk-server-vhd-biztalk-server-sample

This script handles post-Sysprep cleanup and SQL Server login updates. It should be placed in the C:\Windows\Setup\Scripts\ folder.

```batch
del /Q /F c:\windows\system32\sysprep\sysprep.xml
SqlCmd -s . -d Repository -A -Q "drop login [PDC08-CSD\Administrator]"
SqlCmd -s . -d Repository -A -Q "create login [$(COMPUTERNAME)\Administrator] from windows"
SqlCmd -s . -d Repository -A -Q "EXEC sp_changedbowner [$(COMPUTERNAME)\Administrator]"
```

--------------------------------

### HTTP GET Request with Multiple Parameters

Source: https://learn.microsoft.com/en-us/biztalk/core/http-receive-adapter

Example of an HTTP GET request containing multiple query parameters.

```http
http://servername/vroot/BTSHTTPReceive.dll?LocationID=1&MyParam=My%20Value  
```

--------------------------------

### Set up BAM databases via command line

Source: https://learn.microsoft.com/en-us/biztalk/core/how-to-set-up-the-bam-databases-using-the-bam-management-utility

Execute the setup-databases command using the BAM Management utility with a specified configuration file.

```cmd
bm setup-databases -ConfigFile: <configuration file>
```

--------------------------------

### BTAPeopleSoftTrace Usage Example

Source: https://learn.microsoft.com/en-us/biztalk/core/using-event-tracing-for-windows5

Example commands for starting a real-time transmitter trace with a circular log file and stopping the trace.

```cmd
BTAPeopleSoftTrace -transmitter -start -cir 10 -rt C:\log\mylog.etl  
BTAPeopleSoftTrace -transmitter -stop  
```

--------------------------------

### HTTP GET Request without Parameters

Source: https://learn.microsoft.com/en-us/biztalk/core/http-receive-adapter

Example of an HTTP GET request that results in a rejection due to missing parameters.

```http
http://servername/vroot/BTSHTTPReceive.dll  
```

--------------------------------

### BAM Configuration XML Example

Source: https://learn.microsoft.com/en-us/biztalk/core/modifying-the-bam-configuration-schema

A sample configuration file demonstrating the structure for deployment units and properties.

```xml
<?xml version="1.0" encoding="utf-8" ?>  
<BAM:BAMConfiguration xmlns:BAM='urn:schemas-microsoft.com:BAM' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>  
     <DeploymentUnit Name="PrimaryImportDatabase">  
          <Property Name="ServerName">.</Property>  
          <Property Name="DatabaseName">BAMPrimaryImport</Property>  
          <Property Name="RTAWindow">60</Property>  
          <Property Name="RTATimeSlice">5</Property>  
     </DeploymentUnit>  
     <DeploymentUnit Name="StarSchemaDatabase">  
          <Property Name="ServerName">.</Property>  
          <Property Name="DatabaseName">BAMStarSchema</Property>  
     </DeploymentUnit>  
     <DeploymentUnit Name="AnalysisDatabase">  
          <Property Name="ServerName">localhost</Property>  
          <Property Name="DatabaseName">BAMAnalysis</Property>  
     </DeploymentUnit>  
     <DeploymentUnit Name="ArchivingDatabase">  
          <Property Name="ServerName">.</Property>  
          <Property Name="DatabaseName">BAMArchiving</Property>  
     </DeploymentUnit>  
     <DeploymentUnit Name="CubeUpdateDTS">  
          <Property Name="ConnectionTimeOut">15</Property>  
          <Property Name="UseEncryption">1</Property>  
          <Property Name="OwnerPassword">myOwnerPassword</Property>  
          <Property Name="UserPassword">myUserPassword</Property>  
     </DeploymentUnit>  
     <DeploymentUnit Name="DataMaintenanceDTS">  
          <Property Name="ConnectionTimeOut">15</Property>  
          <Property Name="UseEncryption">1</Property>  
          <Property Name="OwnerPassword">myOwnerPassword</Property>  
          <Property Name="UserPassword">myUserPassword</Property>       
     </DeploymentUnit>  
</BAM:BAMConfiguration>
```

--------------------------------

### ListApps Command Sample

Source: https://learn.microsoft.com/en-us/biztalk/core/listapps-command

A simple example of running the ListApps command without optional parameters.

```text
BTSTask ListApps
```

--------------------------------

### BTATIBCORVTrace Execution Example

Source: https://learn.microsoft.com/en-us/biztalk/core/troubleshooting-tibco-rendezvous

Example commands to start a transmitter trace with a circular log file in real-time mode and subsequently stop the trace.

```text
BTATIBCORVTrace -transmitter -start -cir 10 -rt c:\log\mylog.etl  
BTATIBCORVTrace -transmitter -stop  
```

--------------------------------

### Test adapter installation and uninstallation

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/wcf-lob-adapter-sdk/create-a-deployment-package-with-the-wcf-lob-adapter-sdk

Methods to simulate custom actions for testing adapter installation and uninstallation outside of a formal Setup project.

```csharp
/// <summary>  
        /// Use this for testing outside of the Setup project  
        /// </summary>  
        /// <param name="assemblyDirectory">Directory where the adapter assembly is located</param>  
        public static void TestAddConfiguration(string assemblyDirectory)  
        {  
            WCFLOBAdapterInstaller action = new WCFLOBAdapterInstaller();  
            InstallContext context = new InstallContext();  
            // In the Setup project, this is set by selecting custom action  
            // and in Properties setting /INSTALLDIR="[TARGETDIR]\" for CustomActionData  
            context.Parameters.Add("INSTALLDIR", assemblyDirectory);  
            action.Context = context;  
            action.AfterInstallEventHandler(null, null);  
        }  
  
        /// <summary>  
        /// Use this for testing outside of the Setup project  
        /// </summary>  
        /// <param name="assemblyDirectory">Directory where the adapter assembly is located</param>  
        public static void TestRemoveConfiguration(string assemblyDirectory)  
        {  
            WCFLOBAdapterInstaller action = new WCFLOBAdapterInstaller();  
            InstallContext context = new InstallContext();  
            // In the Setup project, this is set by selecting custom action  
            // and in Properties setting /INSTALLDIR="[TARGETDIR]\" for CustomActionData  
            context.Parameters.Add("INSTALLDIR", assemblyDirectory);  
            action.Context = context;  
            action.BeforeUninstallEventHandler(null, null);  
        }  
    }  
}
```

--------------------------------

### Enable Home Organization with Loopback

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/accelerator-rosettanet/step-5-create-a-mirror-agreement

Run this command in the SDK directory to enable the home organization before mirroring agreements.

```cmd
Loopback /enable HOME  
```

--------------------------------

### Full Polling Implementation Example

Source: https://learn.microsoft.com/en-us/biztalk/adapters-and-accelerators/adapter-oracle-database/receive-polling-based-data-changed-messages-in-oracle-db-using-a-wcf-channel

A complete example demonstrating the configuration and setup of the Oracle Database adapter for polling using the WCF channel model.

```csharp
using System;  
using System.Collections.Generic;  
using System.Text;  
  
// Add WCF, WCF LOB Adapter SDK, and Oracle Database adapter namepaces  
using System.ServiceModel;  
using System.ServiceModel.Description;  
using Microsoft.ServiceModel.Channels;  
using Microsoft.Adapters.OracleDB;  
  
// Add this namespace for channel model  
using System.ServiceModel.Channels;  
  
using System.Xml;  
using System.Runtime.Serialization;  
using System.IO;  
  
// Include this namespace for the WCF LOB Adapter SDK and Oracle exceptions  
using Microsoft.ServiceModel.Channels.Common;  
  
namespace OraclePollingCM  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Uri connectionUri = new Uri("oracleDB://ADAPTER/");  
  
            IChannelListener<IInputChannel> listener = null;  
            IInputChannel channel = null;  
  
            // set timeout to receive POLLINGSTMT message  
            TimeSpan messageTimeout = new TimeSpan(0, 0, 30);
```

--------------------------------

### Sample get-changes Output

Source: https://learn.microsoft.com/en-us/biztalk/core/infrastructure-management-commands

Example output showing the command type, user, timestamp, and affected activities or views.

```text
#1: Deploy c:\bam\ordermanagement.xml
By domain\user at 12/30/2005 8:17:08 PM (v3.5.1536.0).
Activities: OrderMgmt
Views: SalesManager
```

--------------------------------

### Get Subscription Command Examples

Source: https://learn.microsoft.com/en-us/biztalk/core/alert-subscription-management-commands

Retrieves a list of subscribers for a specified alert using the bm.exe utility.

```bash
bm.exe get-subscriptions -View:SalesManagerView -Alert:SalesTooLow  
bm.exe get-subscriptions -View:Shipments -Alert:SlowShipment -Server:Ship1  
```
Tokens:
Raw