Skip to content

Commit d3bd2ac

Browse files
committed
more custom setups
1 parent 84db7c3 commit d3bd2ac

File tree

5 files changed

+124
-21
lines changed

5 files changed

+124
-21
lines changed

articles/data-factory/create-azure-ssis-integration-runtime.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ documentationcenter: ''
66
ms.service: data-factory
77
ms.workload: data-services
88
ms.topic: conceptual
9-
ms.date: 02/01/2020
9+
ms.date: 03/27/2020
1010
author: swinarko
1111
ms.author: sawinark
1212
ms.reviewer: douglasl
@@ -273,7 +273,7 @@ $AzureSSISLicenseType = "LicenseIncluded" # LicenseIncluded by default, whereas
273273
$AzureSSISMaxParallelExecutionsPerNode = 8
274274
# Custom setup info: Standard/express custom setups
275275
$SetupScriptContainerSasUri = "" # OPTIONAL to provide a SAS URI of blob container for standard custom setup where your script and its associated files are stored
276-
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO or leave it empty]" # OPTIONAL to configure an express custom setup without script
276+
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO|KingswaySoft.IntegrationToolkit|KingswaySoft.ProductivityPack|Theobald.XtractIS or leave it empty]" # OPTIONAL to configure an express custom setup without script
277277
# Virtual network info: Classic or Azure Resource Manager
278278
$VnetId = "[your virtual network resource ID or leave it empty]" # REQUIRED if you use an Azure SQL Database server with IP firewall rules/virtual network service endpoints or a managed instance with private endpoint to host SSISDB, or if you require access to on-premises data without configuring a self-hosted IR. We recommend an Azure Resource Manager virtual network, because classic virtual networks will be deprecated soon.
279279
$SubnetName = "[your subnet name or leave it empty]" # WARNING: Use the same subnet as the one used for your Azure SQL Database server with virtual network service endpoints, or a different subnet from the one used for your managed instance with a private endpoint
@@ -466,6 +466,24 @@ if(![string]::IsNullOrEmpty($ExpressCustomSetup))
466466
{
467467
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup)
468468
}
469+
if($ExpressCustomSetup -eq "KingswaySoft.IntegrationToolkit")
470+
{
471+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
472+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
473+
}
474+
if($ExpressCustomSetup -eq "KingswaySoft.ProductivityPack")
475+
{
476+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
477+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
478+
}
479+
if($ExpressCustomSetup -eq "Theobald.XtractIS")
480+
{
481+
$jsonData = Get-Content -Raw -Path YourLicenseFile.json
482+
$jsonData = $jsonData -replace '\s',''
483+
$jsonData = $jsonData.replace('"','\"')
484+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString($jsonData)
485+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
486+
}
469487
# Create an array of one or more express custom setups
470488
$setups = New-Object System.Collections.ArrayList
471489
$setups.Add($setup)
@@ -558,7 +576,7 @@ $AzureSSISLicenseType = "LicenseIncluded" # LicenseIncluded by default, whereas
558576
$AzureSSISMaxParallelExecutionsPerNode = 8
559577
# Custom setup info: Standard/express custom setups
560578
$SetupScriptContainerSasUri = "" # OPTIONAL to provide a SAS URI of blob container for standard custom setup where your script and its associated files are stored
561-
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO or leave it empty]" # OPTIONAL to configure an express custom setup without script
579+
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO|KingswaySoft.IntegrationToolkit|KingswaySoft.ProductivityPack|Theobald.XtractIS or leave it empty]" # OPTIONAL to configure an express custom setup without script
562580
# Virtual network info: Classic or Azure Resource Manager
563581
$VnetId = "[your virtual network resource ID or leave it empty]" # REQUIRED if you use an Azure SQL Database server with IP firewall rules/virtual network service endpoints or a managed instance with private endpoint to host SSISDB, or if you require access to on-premises data without configuring a self-hosted IR. We recommend an Azure Resource Manager virtual network, because classic virtual networks will be deprecated soon.
564582
$SubnetName = "[your subnet name or leave it empty]" # WARNING: Use the same subnet as the one used for your Azure SQL Database server with virtual network service endpoints, or a different subnet from the one used for your managed instance with a private endpoint
@@ -708,6 +726,24 @@ if(![string]::IsNullOrEmpty($ExpressCustomSetup))
708726
{
709727
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup)
710728
}
729+
if($ExpressCustomSetup -eq "KingswaySoft.IntegrationToolkit")
730+
{
731+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
732+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
733+
}
734+
if($ExpressCustomSetup -eq "KingswaySoft.ProductivityPack")
735+
{
736+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
737+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
738+
}
739+
if($ExpressCustomSetup -eq "Theobald.XtractIS")
740+
{
741+
$jsonData = Get-Content -Raw -Path YourLicenseFile.json
742+
$jsonData = $jsonData -replace '\s',''
743+
$jsonData = $jsonData.replace('"','\"')
744+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString($jsonData)
745+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
746+
}
711747
# Create an array of one or more express custom setups
712748
$setups = New-Object System.Collections.ArrayList
713749
$setups.Add($setup)
@@ -850,4 +886,7 @@ See other Azure-SSIS IR topics in this documentation:
850886
- [Azure-SSIS integration runtime](concepts-integration-runtime.md#azure-ssis-integration-runtime). This article provides information about integration runtimes in general, including Azure-SSIS IR.
851887
- [Monitor an Azure-SSIS IR](monitor-integration-runtime.md#azure-ssis-integration-runtime). This article shows you how to retrieve and understand information about your Azure-SSIS IR.
852888
- [Manage an Azure-SSIS IR](manage-azure-ssis-integration-runtime.md). This article shows you how to stop, start, or delete your Azure-SSIS IR. It also shows you how to scale out your Azure-SSIS IR by adding more nodes.
853-
- [Join an Azure-SSIS IR to a virtual network](join-azure-ssis-integration-runtime-virtual-network.md). This article provides information about joining your Azure-SSIS IR to a virtual network.
889+
- [Deploy, run, and monitor SSIS packages in Azure](/sql/integration-services/lift-shift/ssis-azure-deploy-run-monitor-tutorial)
890+
- [Connect to SSISDB in Azure](/sql/integration-services/lift-shift/ssis-azure-connect-to-catalog-database)
891+
- [Connect to on-premises data sources with Windows authentication](/sql/integration-services/lift-shift/ssis-azure-connect-with-windows-auth)
892+
- [Schedule package executions in Azure](/sql/integration-services/lift-shift/ssis-azure-schedule-packages)

articles/data-factory/how-to-configure-azure-ssis-ir-custom-setup.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ ms.author: sawinark
1111
manager: mflasko
1212
ms.reviewer: douglasl
1313
ms.custom: seo-lt-2019
14-
ms.date: 02/14/2020
14+
ms.date: 03/27/2020
1515
---
1616

1717
# Customize the setup for an Azure-SSIS Integration Runtime
1818

1919
The custom setup for an Azure-SQL Server Integration Services Integration Runtime (Azure-SSIS IR) provides an interface for adding your own steps during the setup or reconfiguration of your Azure-SSIS IR.
2020

21-
By using the custom setup, you can alter the default operating configuration or environment to, for example, start additional Windows services or persist access credentials for file shares. Or you can install additional components, such as assemblies, drivers, or extensions, on each node of your Azure-SSIS IR.
21+
By using the custom setup, you can alter the default operating configuration or environment to, for example, start additional Windows services, persist access credentials for file shares, or use strong cryptography/more secure network protocol (TLS 1.2). Or you can install additional components, such as assemblies, drivers, or extensions, on each node of your Azure-SSIS IR.
2222

2323
You can do custom setups on your Azure-SSIS IR in either of two ways:
2424
* **Express custom setup without a script**: Run some common system configurations and Windows commands or install some popular or recommended additional components without using any scripts.
@@ -122,6 +122,8 @@ To customize your Azure-SSIS IR, you need the following items:
122122

123123
* If you select the **KingswaySoft's SSIS Productivity Pack** component, you can install the [SSIS Productivity Pack](https://www.kingswaysoft.com/products/ssis-productivity-pack) suite of components from KingswaySoft on your Azure-SSIS IR by entering the product license key that you purchased from them in the **License key** box. The current integrated version is **10.0**.
124124

125+
* If you select the **Theobald Software's Xtract IS** component, you can install the [Xtract IS](https://theobald-software.com/en/xtract-is/) suite of connectors for SAP system (ERP, S/4HANA, BW) from Theobald Software on your Azure-SSIS IR by dragging & dropping/uploading the product license file that you purchased from them into the **License file** box. The current integrated version is **6.1.1.3**.
126+
125127
Your added express custom setups will appear in the **Advanced Settings** section. To remove them, select their check boxes, and then select **Delete**.
126128

127129
![Advanced settings with custom setups](./media/tutorial-create-azure-ssis-runtime-portal/advanced-settings-custom.png)
@@ -134,7 +136,7 @@ To customize your Azure-SSIS IR, you need the following items:
134136
$AzureSSISName = "[your Azure-SSIS IR name]"
135137
# Custom setup info: Standard/express custom setups
136138
$SetupScriptContainerSasUri = "" # OPTIONAL to provide a SAS URI of blob container for standard custom setup where your script and its associated files are stored
137-
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO or leave it empty]" # OPTIONAL to configure an express custom setup without script
139+
$ExpressCustomSetup = "[RunCmdkey|SetEnvironmentVariable|SentryOne.TaskFactory|oh22is.SQLPhonetics.NET|oh22is.HEDDA.IO|KingswaySoft.IntegrationToolkit|KingswaySoft.ProductivityPack|Theobald.XtractIS or leave it empty]" # OPTIONAL to configure an express custom setup without script
138140
139141
# Add custom setup parameters if you use standard/express custom setups
140142
if(![string]::IsNullOrEmpty($SetupScriptContainerSasUri))
@@ -173,6 +175,24 @@ To customize your Azure-SSIS IR, you need the following items:
173175
{
174176
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup)
175177
}
178+
if($ExpressCustomSetup -eq "KingswaySoft.IntegrationToolkit")
179+
{
180+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
181+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
182+
}
183+
if($ExpressCustomSetup -eq "KingswaySoft.ProductivityPack")
184+
{
185+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString("YourLicenseKey")
186+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
187+
}
188+
if($ExpressCustomSetup -eq "Theobald.XtractIS")
189+
{
190+
$jsonData = Get-Content -Raw -Path YourLicenseFile.json
191+
$jsonData = $jsonData -replace '\s',''
192+
$jsonData = $jsonData.replace('"','\"')
193+
$licenseKey = New-Object Microsoft.Azure.Management.DataFactory.Models.SecureString($jsonData)
194+
$setup = New-Object Microsoft.Azure.Management.DataFactory.Models.ComponentSetup($ExpressCustomSetup, $licenseKey)
195+
}
176196
# Create an array of one or more express custom setups
177197
$setups = New-Object System.Collections.ArrayList
178198
$setups.Add($setup)
@@ -198,7 +218,7 @@ To customize your Azure-SSIS IR, you need the following items:
198218

199219
b. Select **Use a SAS URI** and then, in the **URI** box, enter the following SAS URI:
200220

201-
`https://ssisazurefileshare.blob.core.windows.net/publicpreview?sp=rl&st=2018-04-08T14%3A10%3A00Z&se=2020-04-10T14%3A10%3A00Z&sv=2017-04-17&sig=mFxBSnaYoIlMmWfxu9iMlgKIvydn85moOnOch6%2F%2BheE%3D&sr=c`
221+
`https://ssisazurefileshare.blob.core.windows.net/publicpreview?sp=rl&st=2020-03-25T04:00:00Z&se=2025-03-25T04:00:00Z&sv=2019-02-02&sr=c&sig=WAD3DATezJjhBCO3ezrQ7TUZ8syEUxZZtGIhhP6Pt4I%3D`
202222

203223
![Provide the Shared Access Signature for the container](media/how-to-configure-azure-ssis-ir-custom-setup/custom-setup-image10.png)
204224

@@ -214,9 +234,9 @@ To customize your Azure-SSIS IR, you need the following items:
214234

215235
e. Double-click the *UserScenarios* folder to find the following items:
216236

217-
* A *.NET FRAMEWORK 3.5* folder, which contains a custom setup to install an earlier version of the .NET Framework that might be required for custom components on each node of your Azure-SSIS IR.
237+
* A *.NET FRAMEWORK 3.5* folder, which contains a custom setup script (*main.cmd*) to install an earlier version of the .NET Framework that might be required for custom components on each node of your Azure-SSIS IR.
218238

219-
* A *BCP* folder, which contains a custom setup to install SQL Server command-line utilities (*MsSqlCmdLnUtils.msi*), including the bulk copy program (*bcp*), on each node of your Azure-SSIS IR.
239+
* A *BCP* folder, which contains a custom setup script (*main.cmd*) to install SQL Server command-line utilities (*MsSqlCmdLnUtils.msi*), including the bulk copy program (*bcp*), on each node of your Azure-SSIS IR.
220240

221241
* An *EXCEL* folder, which contains a custom setup script (*main.cmd*) to install C# assemblies and libraries that you can use in script tasks to dynamically read and write Excel files on each node of your Azure-SSIS IR.
222242

@@ -252,14 +272,16 @@ To customize your Azure-SSIS IR, you need the following items:
252272
253273
First, upload the 64-bit or the 32-bit version of *librfc32.dll* from the SAP installation folder together with *main.cmd* to your container. The script then copies the SAP assembly to the *%windir%\SysWow64* or *%windir%\System32* folder during setup.
254274

255-
* A *STORAGE* folder, which contains a custom setup to install Azure PowerShell on each node of your Azure-SSIS IR. This setup lets you deploy and run SSIS packages that run [PowerShell scripts to manipulate your Azure storage account](https://docs.microsoft.com/azure/storage/blobs/storage-how-to-use-blobs-powershell).
275+
* A *STORAGE* folder, which contains a custom setup script (*main.cmd*) to install Azure PowerShell on each node of your Azure-SSIS IR. This setup lets you deploy and run SSIS packages that run [PowerShell scripts to manipulate your Azure storage account](https://docs.microsoft.com/azure/storage/blobs/storage-how-to-use-blobs-powershell).
256276
257277
Copy *main.cmd*, a sample *AzurePowerShell.msi* (or use the latest version), and *storage.ps1* to your container. Use *PowerShell.dtsx* as a template for your packages. The package template combines an [Azure Blob download task](https://docs.microsoft.com/sql/integration-services/control-flow/azure-blob-download-task), which downloads *storage.ps1* as a modifiable PowerShell script, and an [Execute process task](https://blogs.msdn.microsoft.com/ssis/2017/01/26/run-powershell-scripts-in-ssis/), which executes the script on each node.
258278

259279
* A *TERADATA* folder, which contains a custom setup script (*main.cmd*), its associated file (*install.cmd*), and installer packages (*.msi*). These files install the Teradata connectors, the Teradata Parallel Transporter (TPT) API, and the ODBC driver on each node of your Azure-SSIS IR Enterprise Edition. This setup lets you use the Teradata Connection Manager, source, and destination to connect to the Teradata server.
260280
261281
First, [download the Teradata Tools and Utilities 15.x zip file](http://partnerintelligence.teradata.com) (for example, *TeradataToolsAndUtilitiesBase__windows_indep.15.10.22.00.zip*), and then upload it together with the previously mentioned *.cmd* and *.msi* files to your container.
262282

283+
* A *TLS 1.2* folder, which contains a custom setup script (*main.cmd*) to use strong cryptography/more secure network protocol (TLS 1.2) and disable older SSL/TLS versions on each node of your Azure-SSIS IR.
284+
263285
* A *ZULU OPENJDK* folder, which contains a custom setup script (*main.cmd*) and PowerShell file (*install_openjdk.ps1*) to install the Zulu OpenJDK on each node of your Azure-SSIS IR. This setup lets you use Azure Data Lake Store and Flexible File connectors to process ORC and Parquet files. For more information, see [Azure Feature Pack for Integration Services](https://docs.microsoft.com/sql/integration-services/azure-feature-pack-for-integration-services-ssis?view=sql-server-ver15#dependency-on-java).
264286
265287
First, [download the latest Zulu OpenJDK](https://www.azul.com/downloads/zulu/zulu-windows/) (for example, *zulu8.33.0.1-jdk8.0.192-win_x64.zip*), and then upload it together with *main.cmd* and *install_openjdk.ps1* to your container.
@@ -275,4 +297,4 @@ To customize your Azure-SSIS IR, you need the following items:
275297
## Next steps
276298

277299
- [Set up the Enterprise Edition of the Azure-SSIS Integration Runtime](how-to-configure-azure-ssis-ir-enterprise-edition.md)
278-
- [Develop paid or licensed custom components for the Azure-SSIS Integration Runtime](how-to-develop-azure-ssis-ir-licensed-components.md)
300+
- [Develop paid or licensed custom components for the Azure-SSIS Integration Runtime](how-to-develop-azure-ssis-ir-licensed-components.md)
20.7 KB
Loading

0 commit comments

Comments
 (0)