Getting Started with the CData SSIS Components for NetSuite
This guide explains everything you need to get started with the CData SSIS Components for NetSuite. You'll learn how to install the components, activate your license, configure your first SSIS connection manager, and build a data flow task to move and transform NetSuite data in your SQL Server Integration Services workflows.
About NetSuite Data Integration
CData provides the easiest way to access and integrate live data from Oracle NetSuite. Customers use CData connectivity to:
- Access all editions of NetSuite, including Standard, CRM, and OneWorld.
- Connect with all versions of the SuiteTalk API (SOAP-based) and SuiteQL, which functions like SQL, enabling easier data querying and manipulation.
- Access predefined and custom reports through support for Saved Searches.
- Securely authenticate with Token-based and OAuth 2.0, ensuring compatibility and security for all use cases.
- Use SQL stored procedures to perform functional actions like uploading or downloading files, attaching or detaching records or relationships, retrieving roles, getting extra table or column info, getting job results, and more.
Customers use CData solutions to access live NetSuite data from their preferred analytics tools, Power BI and Excel. They also use CData's solutions to integrate their NetSuite data into comprehensive databases and data warehouse using CData Sync directly or leveraging CData's compatibility with other applications like Azure Data Factory. CData also helps Oracle NetSuite customers easily write apps that can pull data from and push data to NetSuite, allowing organizations to integrate data from other sources with NetSuite.
For more information about our Oracle NetSuite solutions, read our blog: Drivers in Focus Part 2: Replicating and Consolidating ... NetSuite Accounting Data.
Getting Started
Installation & Licensing
System Requirements
- Windows: Windows 10/11 or Windows Server 2016+
- Visual Studio: Visual Studio 2015 or later
- SQL Server: SQL Server 2014, 2016, 2017, 2019, or 2022
Installing the SSIS Components
- Download the SSIS Components installer for NetSuite from your CData account or the evaluation download page
- Run the installer and follow the installation wizard
- The installer automatically registers the Connection Manager, Source, and Destination components with Visual Studio
- When prompted, activate your license using the product key sent to you by the CData Orders Team:
XXXX-XXXX-XXXX-XXXX-XXXX- Note: To run a trial, choose the Trial Key option.
Enabling SSIS in Visual Studio 2022
If you are using Visual Studio 2022, the SQL Server Integration Services Projects extension must be installed.
- In Visual Studio, select Extensions > Manage Extensions
- Search for SQL Server Integration Services Projects 2022
- Click Install
- Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer
- Reopen Visual Studio. The Integration Services Project template will now appear when creating a new project
Activating Your License
During installation, you are prompted to activate the SSIS Component license. If you need to update or change activation:
License Activation
The installer automatically prompts you to add your license. During installation, you can choose to:
- Use your existing subscription license key, or
- Enter your trial license
To activate a full subscription license, contact the CData Orders Team and request your product key at [email protected].
Enter the license key in the installer when prompted. Once activated, the components will be licensed and ready to use inside Visual Studio without any additional steps.
Runtime Licensing
When deploying SSIS packages, a Runtime Key (RTK) can also be used:
- Set the RTK property in the Connection Manager before deployment
Common Licensing Questions
Can I use my license on multiple machines?
Yes, depending on your subscription tier. Contact [email protected] for details.
I lost my license key. How do I retrieve it?
Email [email protected] with your order number, and we'll resend your license key.
How do I transfer my license to another machine?
Yes. When transferring the license to a different machine, you will need to submit a License Transfer Request on our site linked below:
https://www.cdata.com/lic/transfer/After the License Transfer Request is submitted and successfully processed, an activation will be added to your Product Key and you will be able to activate the full license on the other machine. Once this process is finished, the license on the previous machine will be invalid.
You may also view and upgrade licenses in the self-service portal at portal.cdata.com.
Connection Configuration
Once the components are installed and licensed, you can configure a connection to NetSuite using an SSIS Connection Manager. This Connection Manager stores all authentication and connection properties used by the Source and Destination components.
Creating a Connection Manager
- In the bottom Connection Managers panel of your SSIS package, right-click and select New Connection
- Select CData SSIS Components for NetSuite from the list
- Click Add to open the Connection Manager UI
- Enter the required authentication properties (OAuth, API token, client credentials, etc.) depending on your NetSuite
- Click Test Connection to confirm connectivity
Configuring Connection Properties
The User and Password properties, under the Authentication section, must be set to valid NetSuite user credentials. In addition, the AccountId must be set to the ID of a company account that can be used by the specified User. The RoleId can be optionally specified to log in the user with limited permissions.
See the "Getting Started" chapter of the help documentation for more information on connecting to NetSuite.
Building an SSIS Data Flow
With a Connection Manager created, you can now pull data from NetSuite or push data into it using SSIS data flow tasks.
Creating a Data Flow Task
- In the Control Flow tab, drag a Data Flow Task onto the design surface
- Double-click the task to open the Data Flow workspace
Using the Source Component
- In the SSIS Toolbox, drag the CData NetSuite Source component into the Data Flow
- Double-click it to open the Source Editor
- Select the CData NetSuite Connection Manager you created
- Choose a table or view to extract records from
- Click OK to save your configuration
Using the Destination Component
- Drag a SQL Server Destination onto the canvas
- Double-click it to open the Destination Editor
- Select an existing table or click New to auto-generate a table based on the Source schema
- Connect the Source output to the Destination input and map the columns as needed
- At this point you have created a data flow task for replicating your NetSuite data to a SQL Server database
Testing Your Data Flow
- Return to the Control Flow tab
- Click Start Debugging
- Monitor the progress indicators
- Review row counts and ensure data is loading as expected
Common Connection Issues
Authentication Failed
Solution: Verify OAuth settings, client IDs, secrets, or token permissions for your NetSuite. Contact [email protected] for OAuth troubleshooting.
Cannot Reach Server
Solution: Check firewall, proxy, and VPN configurations. Contact [email protected] for specific port requirements.
Table Not Found
Solution: Confirm you selected the correct schema or database when querying NetSuite.
What's Next
Now that you have installed, licensed, and configured the SSIS Components, here are scenarios you can use to explore our SSIS tools:
| SSIS Component | Article Title |
|---|---|
| BIML | Use Biml to Build SSIS Tasks to Replicate NetSuite to SQL Server |
| SSIS Export | Export Data from SQL Server to NetSuite through SSIS |
| SSIS Import | Import NetSuite Data into SQL Server using SSIS |
| SSIS Lookup | Insert New or Update Existing NetSuite Records from SQL Server |
Get Support
If you need assistance at any point:
- Technical Support: [email protected]
- Community Forum: CData Community Site
- Help Documentation: Installed locally and available online
FAQs
Installation & Licensing
- Do I need administrator rights to install the SSIS Components?
Yes, administrator rights are required to install components for use across Visual Studio. - Do I need an RTK to deploy to Azure Data Factory?
Yes. Set the RTK property in the Connection Manager before publishing.
Connecting
- Can I use multiple NetSuite accounts?
Create separate Connection Managers for each account. - Can I connect through a proxy?
Yes. Configure proxy settings in the Connection Manager properties. - How do I test my connection?
Click Test Connection in the Connection Manager UI.
Performance & Troubleshooting
- Why is my data flow slow?
Add filters, limit rows, and ensure batching settings are configured in the Source component. - How do I enable logging?
Add the following to your connection manager:- Logfile: /path/to/logfile.log
- Verbosity: 3
Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.
For questions not covered in this FAQ, contact [email protected].