Property | S/T | Description |
---|---|---|
BatchResponse | T | Path of the batch response file, which provides detailed results for each object in a batch. These results are useful for the following: • Capturing system-generated object IDs for use in future updates. • Associating errors with objects for exception handling and error diagnosis. A batch response entry is generated for each top-level record. For example, when a Customer record is inserted with an Addressbooklist, only one entry appears in the batch response. For more information about Batch Response File, see Data File Formats. |
CustomizationLevel | ST | Specify the allowed level of NetSuite customizations: • Full (default) - Use this option if using custom record types. Also, provides access to custom fields defined for the standard record types. • CustomFieldsOnly - Use this option if using custom fields defined for the standard record types. Custom fields are requested based on your requirements. For example, the connector does not retrieve custom fields for sales orders if retrieving only customer records. • None - Use this option when custom record types and custom fields are not defined for the standard record types. It improves performance since this option does not require generating A PI calls at startup. Note: This property is applicable only when the DataType property is set to Record. |
DataType | S | Specify how the connector obtains allowable values for the Table list: • Record (default) – Queries the normal record types such as Customer, Contact, SalesOrder, Your CustomRecordType. • Dynamic – Queries using NetSuite saved searches. • CustomList – Queries the NetSuite custom, user-defined lists of ID and value pairs. |
DisableMandatoryCustomFieldValidation | T | Enable or disable validation for the required custom fields: • Default (default) – Connector uses default settings in NetSuite. • True – Data for a custom field (required for NetSuite UI submissions) is not required when submitting a web services request. • False - Connector returns an error when data for a required custom field is not provided. |
DisableSystemNotesCustomFields | T | Enable or disable system-generated notes when importing data from custom fields: • Default - Connector uses the default setting in NetSuite • True - Enable system-generated notes when importing data from custom fields • False - Disable system-generated notes when importing data from custom fields Note: When importing large records, you may consider disabling system notes to improve performance. For more information, see the disableSystemNotesForCustomFields property in the NetSuite documentation. |
FlushFrequency | T | Number of record operations DataConnect engine caches before passing to the connector. Default is zero. |
IgnoreReadOnlyFields | T | Specify whether read-only fields are ignored: • Default - Connector uses the default setting in NetSuite • True - Connector ignores read-only fields. • False - Connector does not ignore read-only fields and enables error messages as required. |
NestedChildren | ST | Set the connector to retrieve records (parents) and their associated lists (children): • True – Connector retrieves records (parents) and their associated lists (children). • False (default) - Connector retrieves records (parents) only. This can significantly improve performance. Note: This property is applicable only when the DataType property is set to Record. |
PageSize | S | Indicates the number of records returned for a page in each web service. It is only applicable when the DataType is selected as Record. Ideally, if DataType is selected as Dynamic or CustomList, the PageSize property should not be displayed. But, this is currently displayed for the connector. The value must be in the range of system defined minimum and maximum value. In a typical configuration, default minimum value is 5 and maximum is 1000). The default value is 50. Note: This property is intended for advanced users who have to fine-tune performance. For more information, see the NetSuite documentation. |
Role | ST | Specify the NetSuite role ID. A role specifies the permissions required to access different parts of NetSuite. If role ID is not provided, the connector uses the user's default role. For more information, see the NetSuite documentation. |
SavedSearchID | ST | The ID of a NetSuite saved search. You can obtain the ID from the URL of the saved search configuration on NetSuite portal. For Example: https://tstdrv1330641.app.netsuite.com/app/common/search/searchresults.nl?searchid=681&whence= The SavedSearchID and the Table selection determine the selected saved search. The DataType property must be set as Dynamic. |
TreatWarningAsError | T | Controls whether warning messages generated by NetSuite are treated same as errors, which causes a request to be rejected. The options are: • Default - Connector uses the default setting in NetSuite. • True - Warning messages generated by NetSuite are treated same as errors. • False - Warning messages generated by NetSuite are not treated same as errors. |
UpdateNulls | T | The NetSuite target may contain empty or null value. The UpdateNulls property controls whether these values are sent to NetSuite: • True - Connector sends null values and empty strings to NetSuite server. • False (the default) - Connector does not send null values and empty strings to NetSuite server. Note: The setting for this property affects only parent-level record types since child record types ignores the null values and empty strings. |
UseUILabel | ST | When creating a custom field, you must specify a name (label). Also, the system automatically generates an ID. The UseUILabel option allows to display either label or custom ID for a custom field. The available options are: • False (default) - Displays custom IDs for custom fields. • True - Displays labels for custom fields. |
Custom FieldType | NetSuite Display Name |
---|---|
Boolean | Check box |
Date | Date Time of Day |
Double | Decimal Number Currency Percent |
Long | Integer Number |
MultiSelect | Multiple Select |
Select | List/Record Image |
String | Free-Form Text Text Area Phone Number E-mail Address HyperLink Rich Text Help Long Text Password |
Example SQL | SQL Statement |
---|---|
Simple query with 'where' clause and field list | Select ExternalId, Title, Status, Message, CUSTEVENT4 from PhoneCall where Select ExternalId, Title, Status, Message, CUSTEVENT4 from PhoneCall where |
Search With Numeric Filter | Select Probability, LeadSource_InternalId, Status, Pro-jectedTotal from Opportunity where ProjectedTotal not-GreaterThanOrEqualTo 1396.70 |
Search with String Filter | Select Title, Status, Message from PhoneCall where Title doesNotStartWith 'TC24889' |
Search with Date Filter | Select Title, StartDate, EndDate, Status, NoEndDate from CalendarEvent where StartDate notOnOrBefore '2006-07-25' |
Simple Subquery | Select InternalId, (select (select Addr1 from 'Addressbook') from 'AddressbookList') from Customer |
Multiple 'and' Clauses | Select EntityId, FirstName, LastName, Email from Contact where EntityId contains 'John' and Email startsWith 'John' and LastName is 'Boy' |
Address-Contact Primary Joined Search | Select CompanyName, Email from Vendor where Email notEmpty '' and ContactPrimaryJoin(Title is 'Quality') |
Customer-SubCustomer Joined Search | Select EntityId, Email from Customer where Email notEmpty '' and SubCustomerJoin(EntityId contains 'subcust') |
Query Using a Single Quote in a Field Value | Select EntityId from Contact where Email is JohnO'Doe@company.com |
Query Using Double Quotes in a Field Value | Select EntityId from Contact where NickName is `John "the bomb"` |
Query Using a Backtick in a Field Value | Select EntityId from Contact where Height is "5`3" |
Operator Category | Operator |
---|---|
Date-Only Operators | after before on onOrAfter onOrBefore notAfter notBefore notOn notOnOrAfter notOnOrBefore notWithin within |
String-only Operators | contains doesNotContain doesNotStartWith is isNot startsWith |
Numeric-Only Operators | between equalTo greaterThan greaterThanOrEqualTo lessThan lessThanOrEqualTo notBetween notEqualTo notGreaterThan notGreaterThanOrEqualTo notLessThan notLessThanOrEqualTo |
ID/Select Field-Only Operators | anyof noneof |
Grammar | Query Statements |
---|---|
query | select field_list from table (where query_terms)? |
field_list | ('(' child_query ')' ',')* ('' (',' '(' child_query ')')) | (field (',' (field | '(' child_query ')'))*) |
child_query | select field_list from table |
Field | Label |
Table | label | string_literal | string_literal_2 | string_literal_3 |
query_terms | simple_term | joined_search (and (simple_term | joined_search)) |
*simple_term | label (operation | label)? value (',' value)* |
operation | '=' | '>' | '<' | '<>' | '>=' | '<=' |
Value | string_literal | decimal | macrodef |
joined_search | label '(" simple_term (and simple_term)* ')' |
Label | character (character | digit | "_")* |
character | ['A' - 'Z'] | ['a' - 'z'] |
Digit | ['0' - '9'] |
Select | 'SELECT' | 'Select' | 'select' |
From | 'FROM' | 'From' | 'from' |
And | 'AND' | 'And' | 'and' |
where | 'AND' | 'And' | 'and' |
string_literal | ''' ( (~[''','\\','\n','\r']) | ('\\' ( ['n','t','b','r','f','\\','\'','\''] | ['0'-'7'] ( ['0'-'7'] )? | ['0'-'3'] ['0'-'7'] ['0'-'7'] ) ) )* ''' |
string_literal_2 | "`" ( (~["`","\\","\n","\r"]) | ("\\" ( ["n","t","b","r","f","`","\\","\'","\""] | ["0"-"7"] ( ["0"-"7"] )? | ["0"-"3"] ["0"-"7"] ["0"-"7"] ) ) )* "`" |
string_literal_3 | "\"" ( (~["\"","\\","\n","\r"]) | ("\\" ( ["n","t","b","r","f","`","\\","\'","\""] | ["0"-"7"] ( ["0"-"7"] )? | ["0"-"3"] ["0"-"7"] ["0"-"7"] ) ) )* "\"" |
decimal | number ('.' number)? |
number | digit+ |
macrodef | '$(' ~[')']+ ')' |