| Panel | |
|---|---|
|
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/at Stonebranch Integration Hub - 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 the universal Universal Controller when the SSIS package execution has been completed.
Version Information
Software Requirements
Software Requirements for Universal Agent
Universal Agent for Linux or Windows Version 7.01.0.0 or later is required.
Universal Agent needs to be installed with python option (--python yes).
Software Requirements Universal Controller
Universal Controller 7.01.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 Hostname 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 are 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
...
Universal
...
Template
To use this downloadable the 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.
...
To import the Universal Template
...
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.
into your Controller, follow these instructions.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Configure
...
Universal Tasks
For the new 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
...
The following will provide a configuration Example for each of the supported Databases:
Database Type: MySQL
Database Type: Oracle - SQL
Database Type: Oracle - PLSQL Block
Database Type: PostgreSQL
Database Type: Microsoft SQL Server
Database Type: SAP HANA
Database Type: MySQL
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
ODBC Drivername
...
Name of the ODBC driver - the field is only relevant for MySQL, PostgreSQL and Microsoft SQL Server.
The following driver are available for selection:
MySQL: MySQL ODBC 8.0 Unicode Driver
MS SQL Server: SQL Server Native Client 11.0,
MS SQL Server: ODBC Driver 17 for SQL Server
PostgreSQL: PostgreSQL Unicode
Additional driver can be added in the SQL Task Universal Template under:
Administration → Universal Templates → SQL → Fields → odbc_drivername → New
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Get Output
...
prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run a SQL script on MySQL
Database Type: Oracle - SQL
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
Mode
...
Connection Authorization Mode:
[sysdba | sysasm | sysoper | sysbkp | sysdgd | syskmt | None]
The field is only relevant oracle connections
...
Script Type
...
The field is only relevant for oracle connections
[SQL Script | PL/SQL Block ]
SQL Script - select to execute an SQL Script
PL/SQL Block - select to run an PL/SQL Block
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Get Output
...
Prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run a SQL Script on Oracle - SQL
Database Type: Oracle - PLSQL Block
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
Mode
...
Connection Authorization Mode:
[sysdba | sysasm | sysoper | sysbkp | sysdgd | syskmt | None]
The field is only relevant oracle connections
...
Script Type
...
The field is only relevant for oracle connections
[SQL Script | PL/SQL Block ]
SQL Script - select to execute an SQL Script
PL/SQL Block - select to run an PL/SQL Block
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Get Output
...
prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run an Oracle - PLSQL Block
Database Type: PostgreSQL
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
ODBC Drivername
...
Name of the ODBC driver - the field is only relevant for MySQL, PostgreSQL and Microsoft SQL Server.
The following driver are available for selection:
MySQL: MySQL ODBC 8.0 Unicode Driver
MS SQL Server: SQL Server Native Client 11.0,
MS SQL Server: ODBC Driver 17 for SQL Server
PostgreSQL: PostgreSQL Unicode
Additional driver can be added in the SQL Task Universal Template under:
Administration → Universal Templates → SQL → Fields → odbc_drivername → New
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Get Output
...
prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run a SQL Script on PostgreSQL
Database Type: Microsoft SQL Server
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
Authentication
...
Supported Methods:
Microsoft SQL Server - Windows Authentication
Microsoft SQL Server - SQL Server Authentication
Note: If “Microsoft SQL Server - Windows Authentication” is chosen you should select under the Agent “Credentials” the Windows user, who should execute the script. The database credentials are not used for SQLSERVER -Windows Authentication.
...
ODBC Drivername
...
Name of the ODBC driver - the field is only relevant for MySQL, PostgreSQL and Microsoft SQL Server.
The following driver are available for selection:
MySQL: MySQL ODBC 8.0 Unicode Driver
MS SQL Server: SQL Server Native Client 11.0,
MS SQL Server: ODBC Driver 17 for SQL Server
PostgreSQL: PostgreSQL Unicode
Additional driver can be added in the SQL Task Universal Template under:
Administration → Universal Templates → SQL → Fields → odbc_drivername → New
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Get Output
...
prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run a SQL Script on Microsoft SQL Server
Database Type: SAP HANA
...
Database Type
...
Type of database to connect:
MySQL
Oracle
PostgreSQL
Microsoft SQL Server
SAP HANA
...
Database Name
...
Database name or oracle service name
...
Database Server
...
Database Servername e.g. localhost
...
Database Port
...
Port of the Database e.g.
MySQL: 3306
Oracle: 1541
PostgreSQL: 5432
Microsoft SQL Server: 1433
SAP HANA: 39013
...
Database Credentials
...
Database Connection Credentials
...
Script
...
The database script to execute Note: The name should not contain a Universal Controller Variable e.g. script name: sb-${ENV}-proc01 will not work, because it contains a variable (${ENV}) in the name.
...
Column Separator
...
The field is only relevant for SAP HANA connections
Output separator
[ Semicolon | Comma | Hash | Whitespace ]
...
Get Output
...
prints the SQL output to STDOUT
In case of an Oracle Stored procedure print the dbms_output to STDOUT.
...
Loglevel
...
Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]
Example: Run a SQL Script on SAP HANA
Document References
This document references the following documents:
...
Name
...
Location
...
Description
...
Universal Templates
...
https://docs.stonebranch.com/confluence/display/UC71x/Universal+Templates
...
User documentation for creating Universal Templates in the Universal Controller user interface.
...
Universal Tasks
...
https://docs.stonebranch.com/confluence/display/UC71x/Universal+Tasks
...
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 | Description |
|---|---|
Documentation about the PYMSSQL Module used in this Universal Task. |
| Anchor | ||||
|---|---|---|---|---|
|
Changelog
ue-microsoft-sql-server-ssis-1.0.4 (2023-05-17)
Bug fix
Fixed:Environment Reference ID is optional and when there is no value, the extension fails.
ue-microsoft-sql-server-ssis-1.0.3 (2023-04-24)
Bug fix
Fixed:Task Doesn't fail when SSIS project name contains spaces