Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/
Overview
SQL Server Integration Services (SSIS) is a platform for building data integrations and data transformation solutions.
This Universal Extension task interactively allows users to list and select the SSIS Folder, Project, Environment Reference, and SSIS Package while creating the job. Furthermore, it can trigger the SSIS package execution in the Microsoft SQL server, monitor the SSIS Package execution, and fetch SSIS logs to Universal Controller when the SSIS package execution has completed.
Software Requirements
Software Requirements for Universal Agent
Universal Agent for Linux or Windows Version 7.0.0.0 or later is required.
Universal Agent needs to be installed with python option (--python yes).
Software Requirements Universal Controller
Universal Controller 7.0.0.0. or later is required.
Software Requirements for the Application to be Scheduled
Microsoft SQL Server Installed with Integration Services Catalog (SSISDB).
Deploy PYMSSQL python package to the universal agent where SSIS Task would be executed.
MS SQL Server Host name or IP address and the Integration services credentials.
Key Features
Dynamic Choice Fields to select the SSIS Folder/Project/Package/Environment Reference ID.
Launch SSIS Package execution.
Monitor SSIS Package execution.
Fetch SSIS Package execution logs.
SSIS Execution ID and Execution status captured for every execution in the Task Instance.
Connection to MS SQL Server is done via the Python PYMSSQL module.
Supports Windows and Linux Universal Agents in order to connect to the MSSQL server.
Import the SSIS Package Execution Universal Extension Task Template
To use this downloadable Universal Template, you first must perform the following steps:
- This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
Copy or Transfer the Universal Template file to a directory that can be accessed by the Universal Controller Tomcat user.
In the Universal Controller UI, select Configuration > Universal Templates to display the current list of Universal Templates.
- Right-click any column header on the list to display an Action menu.
Select Import from the menu, enter the directory containing the Universal Template file(s) that you want to import, and click OK.
When the files have been imported successfully, the Universal Template will appear on the list. Refresh your Navigation Tree to see these tasks in the Automation Center Menu.
Configure SSIS Package Execution Universal Extension Tasks
For this Universal Extension Task type, create a new task and enter the task-specific Details that were created in the Universal Template.
Field Descriptions for SSIS Package Execution Universal Extension Task
Field | Description |
MSSQL Server Name | IP address or Host name of the MSSQL Server. |
MSSQL DB Credentials | MS SQL server credentials for accessing the Integration service Catalogs and SSISDB privileges to create temporary stored procedures. |
MSSQL Database Name | Dynamic choice field to select the database , Default value would be SSISDB. |
SSIS Folder Name | Dynamic choice field to select the SSIS Folder. |
SSIS Project Name | Dynamic choice field to select the Project Name. |
SSIS Package Name | Dynamic choice field to select the SSIS Package. |
Environment Reference ID | Dynamic choice field to select the associated Environment Reference ID for the selected SSIS Package. |
Fetch SSIS Package Logs | If True, then the SSIS execution logs would be fetched to Universal Controller (STDOUT). |
SSIS Execution ID | Output-only text field visible only in task instances; provides the SSIS Execution ID. |
SSIS Execution Status | Output-only text field visible only in task instances; provides the SSIS Execution status from MSSQL server. |
Examples of SSIS Package Execution Universal Extension Tasks
SSIS Universal Task - Select DB Name
Select SSIS Folder Name
Select SSIS Project Name
Select SSIS Package
SSIS Execution - Task Instance
SSIS Execution Logs STDERR / STDOUT
Document References
This document references the following documents:
Name | Location | Description |
---|---|---|
Python PYMSSQL Module Reference | Documentation about the PYMSSQL Module used in this Universal Task. | |
Universal Extension for Universal Controller | https://docs.stonebranch.com/confluence/display/UC72x/Universal+Extension+for+Universal+Controller | User documentation for creating Universal Extension Tasks in the Universal Controller user interface. |