NetSuite Record Listener

You can use the NetSuite Record Listener activity to listen to the Create, Edit, and Delete user events triggered on a specified record and then publish an XML message encapsulating the data of the record on which the event was triggered.

Before you use this activity, the plug-in must be connected to a DMZ server. See Preparing to Use NetSuite Record Listener Activity for detailed information.

This activity supports custom fields and custom records. It also supports publishing custom records if the custom records are associated with parent records that are using:
  • Entity records, such as, Customer record, Contact record, and Vendor record.
  • Transaction records, such as, Sales Order record and Purchase Order record.

This activity does not support publish custom records if the custom records are associated with parent records that are using sublist.

For more information, see Customization.

Note: The NetSuite Record Listener activity supports the same list of trusted third-party certificate authorities (CAs) as Microsoft.

General

In the General tab, you can specify a NetSuite connection and record category. The General tab contains the following fields:

Field Module Property? Description
Name No (Required) Specify a name for the activity in the process definition.
NetSuite Connection Yes (Required) Select a shared connection resource.

Click the icon to select a space connection. If no matching NetSuite connections are found, click Create Shared Resource in the Select NetSuiteConnectionResource Resource Template dialog to create one. See Creating a NetSuite Connection Shared Resource for more details.

Record Category No (Required) Select the top level category of the record type.
Record Subcategory No (Required) Select the subcategory of the record type.
Record No (Required) Select the record type.
Event No (Required) Select the user event triggered on the record that is listened to for data modification:
  • Create: Triggered only when the specified record is created.
  • Edit: Triggered only when the specified record is edited.
  • Delete: Triggered only when the specified record is deleted.
Note: To successfully receive the messages triggered by user events in the NetSuite system, the record type specified in the Record field must be deployed with the identical event type specified in the Record field in the NetSuite system. See the section that describes the running script in TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Installation.
HTTPConnection Yes (Required) Select a HTTP Connector shared resource.
Click the icon to select a HTTP connection.
Note: Make sure the values of the <httpServer> and <httpPort> elements in the RecordListenerHTTPConfig.xml file, which you uploaded to the NetSuite website, are consistent with the values specified in the Host and Port fields respectively.
Relative Path Yes (Required) Select a path relative to the current working directory.
Note: The value of the <httpPath> element in the RecordListenerHTTPConfig.xml file, which you upload to the NetSuite website, must be consistent with the value specified in this field.
Note: The value specified in this field must be appended to the value of the <httpPath> element in the RecordListenerHTTPConfig.xml file, which you upload to the NetSuite website.
Username Yes (Optional) Select the user name that is used to pass the basic authentication of the runtime Record Listener activity.
Note:
  • When a user event is raised on a record in the NetSuite system, if the listener user name and listener password specified in the configuration file, which is deployed on the record, are the same as the ones specified in this activity, this activity receives the messages triggered by the user event.
  • The value of the <listenerUsername> element in the RecordListenerHTTPConfig.xml file, which you uploaded to the NetSuite website, must be consistent with the value specified in this field.
Password Yes (Optional) Select the password that is used to pass the basic authentication of the runtime Record Listener activity.
Note: The value of the <listenerPassword> element in the RecordListenerHTTPConfig.xml file, which you uploaded to the NetSuite website, must be consistent with the value specified in this field.

Description

In the Description tab, you can enter a short description for the activity.

Advanced

In the Advanced tab, you can specify the following fields:

Field Module Property? Description
Sequence Key N/A This field can contain an XPath expression that specifies the processes that must run in a sequence. Process instances with sequence keys that evaluate to the same value are executed sequentially in the order the process instances were created.
Custom Job Id N/A This field can contain an XPath expression that specifies a custom job ID for the process instance.

Conversations

You can initiate or join the conversation here.

Conversations receive messages after the creation of the process instance, which is initiated or joined by an activity. This activity can be used to initiate a conversation. Click the Add New Conversation button to initiate multiple conversations. For more details on conversations, see TIBCO ActiveMatrix BusinessWorks Application Design.

Output

In the Output tab, you can check the response information. In the Output tab, you can find the following fields:

Output Item Data Type Description
eventType String The type of the event. Permissible values are: Create, Edit, and Delete.
recordName String The name of the record on which the event was raised.
recordInternalID String The internalId of the record on which the event was raised.
triggerDateTime DataTime The date and time when the event is triggered in the NetSuite system.
userName String The name of the user who triggered the event in the NetSuite system.
userRoleID String The role ID of the user who triggered the event in the NetSuite system.
userCompanyID String The company ID of the user who triggered the event in the NetSuite system.
userEmailAddress String The email address of the user who triggered the event in the NetSuite system.
userDepartmentID String The department ID of the user who triggered the event in the NetSuite system.
userLocationID String The location ID of the user who triggered the event in the NetSuite system.
timezone String The time zone where the user triggered the event in the NetSuite system.
recordData N/A The attributes and corresponding values of the record on which this event was raised. It varies in record type. For the meaning of each attribute, see NetSuite related documentation.
Note: In some cases, some of the field values that cannot be retrieved by the SuiteScript API are not included in the Output tab.

Fault

The Fault tab lists exceptions that are thrown by this activity. For more detailed information, see Error Codes.

Error Schema Element Data Type Description
NetSuiteEventSourceException
msg String The error message if an error occurred when running the NetSuite Record Listener activity.
msgCode String The error code if an error occurred when running the NetSuite Record Listener activity.