NetSuite Changelog
PlatformSuiteScriptScriptingAPIRelease NotesNew Feature

QueryTask and QueryTaskStatus Object Members for SuiteScript

QueryTask and QueryTaskStatus objects in SuiteScript facilitate asynchronous query processing. Learn their members and usage.

·3 min read·View Oracle Docs

TL;DR

The QueryTask and QueryTaskStatus objects in SuiteScript enable asynchronous execution of query tasks within NetSuite. These objects allow developers to submit queries and track their execution status effectively, which can enhance the performance and efficiency of data-related operations.

What Are QueryTask and QueryTaskStatus?

The QueryTask object is designed to define and submit a query job that processes data asynchronously, while the QueryTaskStatus object is used to monitor the state of those tasks. Leveraging these objects is crucial for optimizing performance in data-heavy applications.

How to Use QueryTask

To create a new query task, you will typically make use of several properties to define the task specifics. Here’s a closer look at the methods and properties of QueryTask:

QueryTask Object Members

Member TypeNameReturn Type / Value TypeSupported Script TypesDescription
MethodQueryTask.submit()stringServer scriptsSubmits the query task for asynchronous processing and returns the task ID.
PropertyQueryTask.fileIdnumberServer scriptsInternal ID of the CSV file to export query results to; mutually exclusive with filePath.
PropertyQueryTask.filePathstringServer scriptsPath of the CSV file for query results export; mutually exclusive with fileId.
PropertyQueryTask.idstringServer scriptsThe ID of the task.
PropertyQueryTask.querystringServer scriptsQuery definition for the query task.

How to Use QueryTaskStatus

The QueryTaskStatus provides essential information regarding the task's current state, helping you to determine when a task has been completed or if it has encountered errors.

QueryTaskStatus Object Members

Member TypeNameReturn Type / Value TypeSupported Script TypesDescription
PropertyQueryTaskStatus.fileIdnumber (read-only)Server scriptsThe internal ID of the CSV file that query results are exported to.
PropertyQueryTaskStatus.query[query.Query] (read-only)Server scriptsQuery definition for the submitted query task.
PropertyQueryTaskStatus.statusstring (read-only)Server scriptsThe status of the submitted query task.
PropertyQueryTaskStatus.taskIdstring (read-only)Server scriptsID of the submitted query task.

Best Practices

  • Always Monitor Task Status: Make sure to check the status of your tasks using QueryTaskStatus to handle any potential failures gracefully.
  • Use Asynchronous Execution: Since tasks are executed asynchronously, ensure that your application logic accounts for this behavior to prevent blocking operations.
  • Leverage QueryTask Properties: Utilize the properties effectively to direct your query results to the appropriate CSV files, which can streamline data exports.

Summary

The QueryTask and QueryTaskStatus objects provide essential tools for managing asynchronous queries in SuiteScript. Understanding their members and capabilities can greatly enhance your data processing frameworks and improve overall application performance.

Key Takeaways

  • QueryTask allows for asynchronous query processing in SuiteScript.
  • QueryTaskStatus monitors the status of submitted tasks.
  • Pay attention to specific properties for optimal task management.
  • Use asynchronous execution to prevent blocking code.

Source: This article is based on Oracle's official NetSuite documentation.

Frequently Asked Questions (4)

Do I need specific permissions to use the QueryTask and QueryTaskStatus objects in SuiteScript?
The article does not specify any particular permissions required to use QueryTask and QueryTaskStatus objects, but they are supported by server scripts, which typically require sufficient permissions to execute.
How does the QueryTask object handle file exports for query results?
The QueryTask object can export query results to a CSV file using either the fileId or filePath properties, but only one of these can be used at a time as they are mutually exclusive.
What type of value does the QueryTask.submit() method return?
The QueryTask.submit() method returns a string, which is the task ID for the asynchronous query task that was submitted.
Is it necessary to manually check the status of a query task after submission?
Yes, it is best practice to monitor the status of your query tasks using the QueryTaskStatus object to handle any potential errors that may occur during execution.
Source: QueryTaskStatus Object Members — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in Platform

View all Platform articles →