With the NetSuite® JDBC connector, you can use commands in a chain to perform structured query language (SQL) operations in NetSuite. For example, with this connector, you can:
- Execute a
SELECT
query in NetSuite - Retrieve tables about a NetSuite table
Note: This connector is built by Workiva and connects to a third-party system. While our Support team can help configure this connector within your workspace, we are unable to troubleshoot or otherwise assist with any issues that originate outside of the Workiva platform.
Prerequisites
To connect to NetSuite, the connector uses Java database connectivity (JDBC) secured with basic username and password authentication.
Note: To enable JDBC with your NetSuite environment, configure the SuiteAnalytics Connect® Service for your tenant.
To set up the connector, you'll need:
- A designated integration user created in NetSuite for the connector with access to NetSuite Analytics Module
- The integration user's username and password
- The JDBC connection's URL, such as
jdbc:ns://[server_host]:[port];ServerDataSource=[datasource];encrypted=1;CustomProperties=(AccountID=[accountID];RoleID=[roleID])
, with the same account and role set up in SuiteAnalytics Connect for the NetSuite tenant
Note: To connect to an on-premises instance of NetSuite, you'll need a GroundRunner for the connector with Java Virtual Machine (JVM) installed on its environment. To connect to a cloud instance of NetSuite, use the default CloudRunner.
Set up the NetSuite JDBC connector
To make the connector available for use in your organization's chains, an org security administrator must first enable it from Configuration.
Then:
- From Chain Builder, click Connections , and then Create at the top right.
- Under BizApp Connection, select NetSuite JDBC and the runner to use with the connection.
- Enter a unique name and description to help identify the connection.
- Under Properties, enter the connector's details:
Property Details Username Enter the username of the connector's NetSuite integration user. Password Enter the password for the Username property. Connection URL Enter the URL for the JDBC connection with any optional properties appended following a semicolon. For instance:
By default, the port isjdbc:ns://[server_host]:[port];ServerDataSource=[datasource];encrypted=1;CustomProperties=(AccountID=[accountID];RoleID=[roleID])
1708
.Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption. For security purposes, avoid including user credentials as custom properties within the Connection URL input.
- Select the environments to use with the connection, and click Save.
- To test the connection, create and run a chain with the connector's Get Table Definition command, and verify it returns a valid output.
Troubleshooting
Custom fields
Please note that the NetSuite API cannot return custom fields. As an alternative, Data Prep can create transformations that mimic the logic of a Netsuite custom field.
Failed connection
If the connection to NetSuite fails:
- Verify the integration user's authentication credentials
- Check the URL for the JDBC connection, including its server and port
If the connection fails to perform a command, verify its inputs—such as its SQL syntax or table—are valid.