tibco activematrix businessworks plug-in for netsuite user ... activematrix businessworks plug-in...

TIBCO ActiveMatrix BusinessWorks™ Plug-infor NetSuite User's GuideSoftware Release 6.0May 2014

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Business Studio, andTIBCO Enterprise Administrator are either registered trademarks or trademarks of TIBCO SoftwareInc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2013-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for NetSuite User's Guide

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Introduction to NetSuite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Creating a NetSuite Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Debugging and Running a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

NetSuite Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

NetSuite Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

NetSuite Record Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

NetSuite Add Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

NetSuite Update Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

NetSuite Upsert Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

NetSuite Delete Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

NetSuite Get Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

NetSuite GetAll Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

NetSuite Search Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

NetSuite Invoke SavedSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Get WSDL and Schema Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Overview of WSDL and Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Overview of Get WSDL and Schema Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Getting WSDL and Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Custom Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Custom Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Custom List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Proxy Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Set Proxy at Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Set Proxy at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

The NetSuite Record Listener Activity Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Preconfiguration on the Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Enumeration Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Host Name Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

3


Importing the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Configuring the NetSuite Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Working with the InvokeSavedSearch_paging Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Working with the Record_Listener Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

Working with Other Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Description of the Add_Update_Get_Delete Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

Description of the GetAll Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

Description of the Search_Paging Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Description of the Upsert_Delete Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4


Figures

Get WSDL and Schema Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Proxy Entry Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Run Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

5


TIBCO Documentation and Support Services

All TIBCO documentation is available in the TIBCO Documentation Library, which can be found here:

https://docs.tibco.com

Product-Specific Documentation

The following documents for this product can be found in the TIBCO Documentation Library:

● TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Installation● TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite User's Guide● TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Release Notes

The following documents provide additional information and can be found in the TIBCODocumentation Library:

● TIBCO ActiveMatrix BusinessWorks Documentation● TIBCO Enterprise Administrator User's Guide

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support asfollows:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

http://www.tibco.com/services/support

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to:

http://www.tibcommunity.com

6


https://docs.tibco.com

http://www.tibco.com/services/support

https://support.tibco.com

http://www.tibcommunity.com

Introduction to NetSuite

NetSuite is a cloud-based integrated business management software. It provides enterprise services.

It provides the following enterprise services:

● Financial Management● Supply Chain and Inventory Management● Order and Billing Management● Shipping and Fulfillment● Revenue Recognition Management● Financial Planning● Human Capital Management (HCM)● Recurring Revenue Management● Financial Analytics and Reporting

For more information on NetSuite, see the NetSuite product documentation available on NetSuite’swebsite.

7


Plug-in Overview

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite integrated with TIBCO BusinessWorksprovides a user-friendly environment that allows you to add, update, upsert, delete, and search yourenterprise data hosted on the NetSuite cloud platform.

TIBCO ActiveMatrix BusinessWorks is an easy to use integration product suite for enterprise, web, andmobile applications. It uses the Eclipse graphical user interface (GUI), TIBCO Business Studio, fordefining business processes and the process engine to execute them.

The plug-in provides the following functionalities:

● The NetSuite Connection shared resource contains all necessary parameters to establish connectionto an instance of your enterprise data set hosted on the NetSuite platform. It is used for all thesupported activities to manage your enterprise data.

● The NetSuite Record Listener activity is used to listen to the Create, Edit, and Delete user eventstriggered on a specified record and publish an XML message encapsulating the data of the record onwhich the event was triggered.

● The NetSuite Add Record activity is used to add new records to the NetSuite system.● The NetSuite Update Record activity is used to update records in the NetSuite system.● The NetSuite Upsert Record activity is used to add or update records to the NetSuite system.● The NetSuite Delete Record activity is used to delete records from the NetSuite system.● The NetSuite Get Record activity is used to retrieve records from the NetSuite system with internal

IDs or external IDs.● The NetSuite GetAll Records activity is used to retrieve all the records that match the specified

record type in the NetSuite system.● The NetSuite Search Record activity is used to search records based on the specified search criteria.● The NetSuite Invoke SavedSearch activity is used to retrieve and execute the search queries that are

created and saved in the NetSuite system.● The Get WSDL and Schema Tool is used to fetch WSDL and schemas from the NetSuite platform.

8


Getting Started

A typical workflow for using the plug-in to achieve different goals includes creating a process, testing itin the debugger, and deploying the application.

TIBCO ActiveMatrix BusinessWorks uses the Eclipse graphical user interface (GUI) provided by TIBCOBusiness Studio to define business processes and generate Enterprise Archives (EAR files). The EARfiles is deployed and run in the ActiveMatrix BusinessWorks runtime, and also is managed by usingTIBCO Enterprise Administrator (TEA).

The typical workflow for using the plug-in is:

1. Creating a Project

2. Creating a NetSuite Connection Shared Resource

3. Configuring a Process

4. Debugging and Running a Process

5. Deploying an Application

Creating a ProjectBusinessWorks application modules are Eclipse projects that are created in TIBCO Business Studio,which contain various resources.

Procedure

1. Start TIBCO Business Studio.

2. Select File > New > BusinessWorks Resources.

3. Click the BusinessWorks Application Module resource in the BusinessWorks Resource wizard.Click Next.

There are several ways to open the New BusinessWorks Application Module dialog andcreate a new project in TIBCO Business Studio. See the TIBCO ActiveMatrixBusinessWorks documentation for more information.

4. Type a name for the project that you are creating in the Project name field.

5. Keep the Use default location, Create empty process, and Create Application check boxes selected.Click Finish.

Result

A project and an application are created and displayed in the Project Explorer view. The Process editoropens automatically.

9


Creating a NetSuite Connection Shared ResourceThe NetSuite Connection shared resource is used for all the supported activities to manage yourenterprise data.

Prerequisites

The NetSuite Connection shared resource is available at the Resources level. Before creating a NetSuiteConnection shared resource, you need to create a project, see Creating a Project.

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resources folder and click New > NetSuite Connection.

3. Type a name for the NetSuite Connection shared resource in the Resource Name field. Click Finish.

4. Configure the NetSuite Connection shared resource in the NetSuite Connection editor.

See NetSuite Connection regarding the configuration fields.

5. Click Test Connection to validate the connection.

10


Configuring a ProcessProcesses define the business logic. Once a project is created, you need to configure the process byadding activities, conditions, and services.

Procedure

1. Select an activity from the Palette view and drop it in the Process editor.For example, select and drop the Timer activity from the General Activities folder and the NetSuiteAdd Record activity from the NetSuite folder.

2. Click the icon to create links between the activities and configure the condition types.

3. Configure the added activities, as described in NetSuite Palette.

A NetSuite Connection shared resource is required when configuring the activities. See Creating a NetSuite Connection Shared Resource for more details on how to create theNetSuite Connection shared resource.

4. Click File > Save to save the process.

Debugging and Running a ProcessDebug the application you have configured to ensure that the application configuration is correct.

Procedure

1. Open the process you have configured in TIBCO Business Studio.

2. On the toolbar, click Run > Debug Configurations.

3. Click BusinessWorks Application > BWApplication in the left panel.

4. Ensure only the application you want to debug and run is selected in the Applications tab in theright panel.

11


5. Click the Advanced tab and click Browse to locate the logback file.By default, the log file resides in the TIBCO_HOME/bw/6.0/config/design/logback directory anderror logs are captured. See Managing Logs for more details.

6. Click Debug.TIBCO Business Studio changes to the Debug perspective. Logs are displayed in the Console view.

Deploying an ApplicationAfter deploying the applications, you can manage BusinessWorks applications by using TIBCOEnterprise Administrator.

Prerequisites

The following tasks are required before deploying applications:

● Creating a Project.● Generating an EAR File.

A complete workflow of deployment includes:

1. Upload an EAR file.

2. Deploy an application.

3. Configure an application.

4. Start an application.

See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

Generating an EAR FileApplication archives are the enterprise archive (EAR) files that are created in TIBCO Business Studio.An EAR file is required to deploy the BusinessWorks application to TIBCO Administrator.

Prerequisites

An application project has already been created, see Creating a Project.

There are many ways to generate an EAR file, the following is one method. See TIBCO ActiveMatrixBusinessWorks Administration for more information.

Procedure

1. Go to the File Explorer view and click the Open Directory to Browse icon.

2. Select the folder where you want to generate the EAR file and click OK.The new folder is displayed in the File Explorer view.

3. Drag the application from the Project Explorer view to the new folder in the File Explorer view.

The EAR file is generated with the name <name>.<application>_<version>.ear.

12


NetSuite Connection

The NetSuite Connection shared resource contains all necessary parameters to establish a connection toan instance of your enterprise data set hosted on the NetSuite platform.

This shared resource only supports HTTPS connection and is used for all the supported activities tomanage your enterprise data.

General

The General panel contains the following fields.

FieldModuleProperty? Description

Package No (Optional) The name of the package.

Name No (Required) The name of the shared resource.

Description No (Optional) A short description of the resource.

NetSuite Connection Configuration

The NetSuite Connection Configuration panel contains the following fields.


Login Email Yes (Required) The email address to access the NetSuite system.

LoginPassword

Yes (Required) The password to access the NetSuite system.

Login Account No (Required) The account number.

If the values you input in the Login email and LoginPassword fields are correct, the value in this field will beautomatically displayed after you click Retrieve AccountInformation.

Login Role No (Required) The role with which you log in to the NetSuite system.


EndpointVersion

No (Required) The version of the endpoint you want to connect to.

13



Endpoint URL No (Required) The location of the endpoint you want to connect to.


Retrieve Account Information

The Retrieve Account Information button allows you to retrieve the information of the account youinput.

Click this button to automatically retrieve account information of the Login Account, Login Role, andEndpoint URL fields after you specified values in the Login email and Login Password fields.

Test Connection

The Test Connection button allows you to test whether the specified configuration fields result in avalid connection to the NetSuite system for design time configuration and runtime execution of theactivities.

14


NetSuite Palette

The NetSuite palette contains activities that can be added to your business processes.

NetSuite Record ListenerThe NetSuite Record Listener activity is used to listen to the Create, Edit, and Delete user eventstriggered on a specified record and then publish an XML message encapsulating the data of the recordon which the event was triggered.

You should check the configuration of this activity before using it. See The NetSuite Record ListenerActivity Configuration for detailed information.

This activity supports custom fields and custom records. It also supports publishing custom records ifthe 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.

But this activity does not support publish custom records if the custom records are associated withparent records that are using sublist.

For more information, see Customization for more information.

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

General

The General tab contains the following fields.


Name No (Required) The name of the activity in the process definition.

NetSuiteConnection

Yes (Required) Specifies a shared connection resource.

Click the icon to select a space connection. If no matchingNetSuite connections are found, click Create Shared Resource inthe Select NetSuiteConnectionResource Resource Templatedialog to create one. See Creating a NetSuite Connection SharedResource for more details.

Record Category No (Required) Specifies the top level category of the record type.

RecordSubcategory

No (Required) Specifies the subcategory of the record type.

Record No (Required) Specifies the record type.

15



Event No (Required) Specifies the user event triggered on the record thatwill be listened to for data modification:

● Create: Triggered only when the specified record is created.● Edit: Tiggered only when the specified record is edited.● Delete: Triggered only when the specified record is deleted.

To successfully receive the messages triggered by userevents in the NetSuite system, the record type specifiedin the Record field must be deployed with the identicalevent type specified in the Record field in the NetSuitesystem. See the section that describes the running scriptin TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuiteInstallation.

HTTPConnection Yes (Required) Specifies a HTTP Connector shared resource.

Click the icon to select a HTTP connection.

Relative Path Yes (Required) Specifies a path relative to the current workingdirectory.

The value of the <httpPath> element in theRecordListenerHTTPConfig.xml file, which youuploaded to the NetSuite website, must be consistentwith the value specified in this field.

Username Yes (Optional) Specifies the user name that is used to pass the basicauthentication of the runtime Record Listener activity.

● When a user event is raised on a record in theNetSuite system, if the listener username andlistener password specified in the configuration file,which is deployed on the record, are the same as theones specified in this activity, this activity willreceive the messages triggered by the user event.

● The value of the <listenerUsername> element in theRecordListenerHTTPConfig.xml file, which youuploaded to the NetSuite website, must beconsistent with the value specified in this field.

Password Yes (Optional) Specifies the password that is used to pass the basicauthentication of the runtime Record Listener activity.

The value of the <listenerPassword> element in theRecordListenerHTTPConfig.xml file, which youuploaded to the NetSuite website, must be consistentwith the value specified in this field.

16


Description

Provide a short description for the activity.

Advanced

The Advanced tab contains the following fields.


Sequence Key N/A This field can contain an XPath expression that specifies whichprocesses should run in a sequence. Process instances with sequencekeys that evaluate to the same value are executed sequentially in theorder the process instances were created.

Custom Job Id N/A This field can contain an XPath expression that specifies a customjob ID for the process instance.

Conversations

You can initiate or join the conversation here.

Conversations receive message 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 ActiveMatrixBusinessWorks Application Design.

Output

The Output tab contains the following fields.

Output Item Data Type Description

eventType String The type of the event. Permissible values are: Create, Edit, andDelete.

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 NetSuitesystem.

userName String The name of the user who triggered the event in the NetSuitesystem.

userRoleID String The role ID of the user who triggered the event in the NetSuitesystem.

userCompanyID String The company ID of the user who triggered the event in theNetSuite system.

17



userEmailAddress String The email address of the user who triggered the event in theNetSuite system.

userDepartmentID String The department ID of the user who triggered the event in theNetSuite system.

userLocationID String The location ID of the user who triggered the event in theNetSuite system.

timezone String The time zone where the user triggered the event in the NetSuitesystem.

recordData N/A The attributes and corresponding values of the record on whichthis event was raised. It varies in record type. For the meaning ofeach attribute, see NetSuite related documentation.

In some cases, some of the field values that cannot beretrieved by the SuiteScript API are not included in theOutput tab.

Fault

The Fault tab lists exceptions that are thrown by this activity.

Error SchemaElement Data Type Description

NetSuiteEventSourceException

msg String The error message if an error occurred when running the NetSuiteRecord Listener activity.

msgCode String The error code if an error occurred when running the NetSuiteRecord Listener activity.

NetSuite Add RecordThe NetSuite Add Record activity is used to add new records to the NetSuite system.

This activity supports batch operations, which means you can add multiple records at a time. If youwant to add data collection to the NetSuite system in a batch, you can use the For-Each statement tomap the data collection to the elements in the Input field in the NetSuite Add Record activity. It alsosupports custom fields, custom records, and custom lists, see Customization for more information.

General




18



NetSuiteConnection


Click the icon to select a NetSuite connection. If no matchingNetSuite connections are found, click Create Shared Resource in theSelect NetSuiteConnectionResource Resource Template dialog tocreate one. See Creating a NetSuite Connection Shared Resource formore details.

RecordCategory

No (Required) Specifies the top level category of the record type.

RecordSubcategory



Description


Input

The Input tab contains the following fields.

FieldDataType Description

Records

@externalId String (Optional) The external ID of the new record. If this field is notempty, its value must be unique in the same record type.

items N/A The attributes of the new record. It varies in record type.

● Values for the lastModifiedDate and createdDateelements are generated by the NetSuite system. If youspecify values for these two elements, it will not takeeffect when you running this activiity.

● In the General tab, when you select Transactions fromthe Record Category list, select Customers from theRecord Subcategory list, and select Charge from theRecord list, this activity cannot be executed if youspecify values to the chargeType, stage, or useelements.

Output


19



Success Boolean This element indicates the status of all of the operations. If no erroroccurs when adding one or more records, the status true isreturned.

Results

Result The Result element contains the status and baseRef elements.

status The status element contains the following elements:

● @isSuccess (A Boolean value): This property indicates the statusof the current operation. If no error occurs when adding a record,the status true is returned.

● statusDetail: This element contains the following sub-elements:

— @type (A String value): The type of the message returnedfrom the NetSuite system, which includes ERROR, WARN, andINFO.

— code (A String value): The code of the message returnedfrom the NetSuite system.

— message (A String value): The message returned from theNetSuite system.

baseRef The baseRef element contains the following elements:

● @internalId (A String value): The internal ID of the addedrecords.

● @externalId (A String value): The external ID of the addedrecords.

● @type (A String value): The type of the added records.

Fault



NetSuitePluginException

msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite errormessage.

msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite errorcode.

NetSuiteServerException

20



msg String The NetSuite system error message when processing a request fromthe plug-in.

msgCode String The NetSuite system error code when processing a request from theplug-in.

NetSuiteMSG String The NetSuite server error message when processing a request fromthe plug-in.

NetSuite Update RecordThe NetSuite Update Record activity is used to update records in the NetSuite system.

This activity supports batch operations, which means you can update multiple records at a time. If youwant to update a data collection in the NetSuite system in a batch, you can use the For-Each statementto map the data collection to the elements in the Input fields in the NetSuite Update Record activity. Italso supports custom fields, custom records, and custom lists, see Customization for more information.

General




NetSuiteConnection


Click the icon to select a space connection. If no matchingNetSuite connections are found, click Create Shared Resource in theSelect NetSuiteConnectionResource Resource Template dialog tocreate one. See Creating a NetSuite Connection Shared Resource formore details.

RecordCategory


RecordSubcategory



Description


Input


21



Records

@internalId String (Required) The internal ID of the record to be updated.

@externalId String (Optional) The external ID of the new record to be updated. If thisfield is not empty, its value must be unique in the same record type.

items N/A The attributes of the record. It varies in record type.

● Values for the lastModifiedDate and createdDateelements are generated by the NetSuite system. If youspecify values for these two elements, it will not takeeffect when you running this activity.

● In the General tab, if you select Transactions from theRecord Category list, select Customers from the RecordSubcategory list, and select Charge from the Recordlist, this activity cannot be executed if you assign valuesto the chargeType, stage, or use elements.

Output



Success Boolean This property indicates the status of all of the operations. If no erroroccurs when adding one or more records, the status true isreturned.

Results








22




● @internalId (A String value): The internal ID of the updatedrecords.

● @externalId (A String value): The external ID of the updatedrecords.

● @type (A String value): The type of the updated records.

Fault










NetSuite Upsert RecordThe NetSuite Upsert Record is used to add or update records to the NetSuite system.

If the external ID of the new record exists in the NetSuite system, the new record will update theexisting record that has the same external ID. Otherwise, a new record will be created in the NetSuitesystem.

This activity supports batch operations, which means you can upsert multiple records at a time. If youwant to upsert a data collection in the NetSuite system in a batch, you can use the For-Each statement tomap the data collection to the elements in the Input fields in the NetSuite Upsert Record activity. It alsosupports custom fields, custom records, and custom lists, see Customization for more information.

General


23




NetSuiteConnection



RecordCategory


RecordSubcategory



Description


Input



Record

@externalId String (Required) The external ID of the new record to be upserted.

items N/A The attributes of the record. It varies in record type.

● Values for the lastModifiedDate and createdDateelements are generated by the NetSuite system. Valuesinput in these two fields do not take effect.

● In the General tab, if you select Transactions from theRecord Category list, select Customers from the RecordSubcategory list, and select Charge from the Recordlist, this activity cannot be executed if you assign valuesto the chargeType, stage, or use elements.

Output


24




Results









● @internalId (A String value): The internal ID of the upsertedrecords.

● @externalId (A String value): The external ID of the upsertedrecords.

● @type (A String value): The type of the upserted records.

Fault







25






NetSuite Delete RecordThe NetSuite Delete Record activity is used to delete records from the NetSuite system.

This activity supports batch operations, which means you can delete multiple records at a time. If youwant to delete a data collection from the NetSuite system in a batch, you can use the For-Each statementto map the data collection to the elements in the Input field in the NetSuite Delete Record activity. Italso supports custom fields, custom records, and custom lists, see Customization for more information.

General




NetSuiteConnection



RecordCategory


RecordSubcategory



Description


Input


26



baseRef

At least one of the following elements is required. If both of them are given values, thevalue in the @internalId element is used to delete records.

@internalId String The internal IDs of the records you want to delete from the NetSuitesystem.

@externalId String The external IDs of the records you want to delete from the NetSuitesystem.

Output



Success Boolean This element indicates the status of all of the operations. If no erroroccurs when adding one or more records, the status true isreturned.

Results



● @isSuccess (A Boolean value): This element indicates the statusof the current operation. If no error occurs when adding a record,the status true is returned.






● @internalId (A String value): The internal ID of the deletedrecords.

● @externalId (A String value): The external ID of the deletedrecords.

● @type (A String value): The type of the deleted records.

27


Fault










NetSuite Get RecordThe NetSuite Get Record activity is used to retrieve records from the NetSuite system with internal IDsor external IDs.

This activity supports batch operations, which means you can retrieve multiple records at a time. If youwant to retrieve a data collection from the NetSuite system in a batch, you can use the For-Eachstatement to map the data collection to the elements in the Input fields in the NetSuite Get Recordactivity. It also supports custom fields, custom records, and custom lists, see Customization for moreinformation.

General




NetSuiteConnection



28



RecordCategory


RecordSubcategory



Description


Input



baseRef

At least one of the following elements is required. If both of them are given values, thevalue in the @internalId element is used to retrieve records.

@internalId String The internal IDs of the records you want to retrieve from theNetSuite system.

@externalId String The external IDs of the records you want to retrieve from theNetSuite system.

Output


Output ItemDataType Description

RecordCategory String The top level category of the returned records.

RecordSubCategory String The subcategory of the returned records.

Record String The record type of the returned records.

Results

Result The Result element contains the status and Record elements.

29




● @isSuccess (A Boolean value): This element indicates thestatus of the current operation. If no error occurs whenretrieving a record, the status true is returned.


— @type (A String value): The type of the message returnedfrom the NetSuite system, which includes ERROR, WARN,and INFO.



record The record element contains the following elements:

● @internalId (A String value): The internal ID of the retrievedrecords.

● @externalId (A String value): The external ID of the retrievedrecords.

● item: The attributes of the record. It varies in record type.

In the General tab, when you select Transactionsfrom the Record Category list, select Customersfrom the Record Subcategory list, and selectCustomerRefund from the Record list, the values inthe depositList element are displayed in theapplyList element.

Fault







30






NetSuite GetAll RecordsThe NetSuite GetAll Records activity is used to retrieve all the records that match the specified recordtype in the NetSuite system.

General




NetSuiteConnection



RecordCategory


RecordSubcategory



Description


Output


31



RecordCategory String The top level category of the record type you chose in theGeneral tab.

RecordSubCategory String The subcategory of the record type you chose in the Generaltab.

RecordType String The record type you chose in the General tab.

Success Boolean This element indicates the status of all of the operations. If noerror occurs when retrieving all records, the status true isreturned.

total Integer The number of returned records.

Message String The error messages or warning messages returned from theNetSuite system.

Results

record String The attributes of the returned records.

Fault










32


NetSuite Search RecordThe NetSuite Search Record activity is used to search records based on the specified search criteria.

This activity supports paging search. It also supports custom fields, custom records, and custom lists,see Customization for more information.

General




NetSuiteConnection



RecordCategory


RecordSubcategory

No (Required) Specifies the subcategory of the search record type.

Search Record No (Required) Specifies the search record type.

Record Type No (Required) Specifies the record type.

This filed is only displayed in one of the following twoconditions:● If you select Lists from the Record Category list, select

Accounting from the Record Subcategory list, andselect ItemSearch from the Search Record list.

● If you select Transactions from the Record Categorylist, select Sales from the Record Subcategory list, andselect TransactionSearch from the Search Record list.

Page Size Yes (Required) Specifies the maximum number of records that are to bereturned on each page.

The value must be an integer that is greater than or equal to 5. Thedefault value is 100. The recommended value is in the range 100 -5000.

Description


33


Input



searchRecord

basic N/A The attributes of the specified search record type. For moreinformation about the attributes, see NetSuite related documentation.

In the General tab, if you select Lists from the RecordCategory list, Accounting from the Record Subcategorylist, and SubsidiarySearch from the Search Record list,any input in the state element does not take effect.

Output



Success Boolean This property indicates the status of all of the operations. If no erroroccurs when searching records, the status true is returned.


SearchResult The SearchResult element contains the following elements:

● totalRecords (A String value): The total number of searchedrecords.

● pageSize (A String value): The maximum number of recordsthat are to be returned on each page. It is the same as the valuespecified in the General tab.

● totalPages (A String value): The number of pages.

● pageIndex (A String value): The index of the current page.

● searchId (A String value): The search ID of this operation. Thevalue in this field was allocated by the NetSuite system.

● RecordList: This element contains the following sub-element:

— record: The attributes of searched record. For moreinformation about the attributes, see NetSuite relateddocuments.

Fault


34




msg string The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite errormessage.

msgCode string The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite errorcode.


msg string The NetSuite system error message when processing a request fromthe plug-in.

msgCode string The NetSuite system error code when processing a request from theplug-in.


NetSuite Invoke SavedSearchThe NetSuite Invoke SavedSearch activity is used to retrieve and execute the search queries that arecreated and saved in the NetSuite system.

This activity supports custom fields, custom records, and custom lists, see Customization for moreinformation. It also supports paging search. This feature can be used when the search criteria isexpected to return a large number of records. You can define the maximum number of records for eachpage and use the group function to iteratively search all the records that match the search conditions.For more information about the group, see TIBCO ActiveMatrix BusinessWorks Concepts.

General




NetSuiteConnection



RecordCategory

No (Required) Specifies the top level category of the search record type.

RecordSubcategory

No (Required) Specifies the subcategory of the search record type.

35



Search Record No (Required) Specifies the search record type.

SavedSearches

No (Required) The search criteria for searching records.

Click Fetch Saved Searches to fetch available search criteria savedin the NetSuite system. The search criteria is filtered based on thesearch record type.

Page Size Yes (Required) Specifies the maximum number of records that can besearched on each page.

The value must be an Integer that is greater than or equal to 5. Thedefault value is 100. The recommended value is in the range 100 -5000.

Description


Output





SearchResult The SearchResult element contains the following elements:

● totalRecords (A String value): The total number of searchedrecords.

● pageSize (A String value): The maximum number of recordsthat are to be returned on each page. It is the same as the valuespecified in the General tab.

● totalPages (A String value): The number of pages.

● pageIndex (A String value): The index of the current page.

● searchId (A String value): The search ID of this operation. Thevalue of this element was allocated by the NetSuite system.

● searchRowList: This element contains the following sub-element:

— searchRow: The attributes of searchRow. For moreinformation about the meaning of attributes, see NetSuiterelated documents.

36


Fault










37


Get WSDL and Schema Tool

You can use the Get WSDL and Schema tool to fetch WSDL and schemas from NetSuite platform.

Overview of WSDL and SchemasThe SuiteTalk WSDL and schemas are required for design time configuration and runtime execution ofvarious activities supported by this plug-in.

SuiteTalk WSDL

The Web Services Description Language (WSDL) is an XML-based interface description language thatis used to describe the functionality offered by a web service. The SuiteTalk WSDL provides a completedescription of available services, operations, and messages.

NetSuite provides several versions of SuiteTalk WSDL and schemas. Version v2013_2_0 is shipped withthis plug-in. After installation, you can find it in the TIBCO_HOME\BW\palettes\netsuite\version_number\wsdls directory.

You can download other versions of SuiteTalk WSDL and schemas from the NetSuite platform by usingthe Get WSDL&Schema Tool.

SuiteTalk Schemas

The SuiteTalk Schemas define various elements, attributes, and their corresponding types that make upa record. It also defines the semantics for various errors and faults that are raised due to the invocationof SuiteTalk web service operations.

Overview of Get WSDL and Schema ToolThe Get WSDL and Schema tool is used to fetch WSDL and schemas from the NetSuite platform. Itrequires you to download WSDL and schemas through full URL of the endpoint.

The Get WSDL and Schema tool is deployed on your machine after installing TIBCO ActiveMatrixBusinessWorks Plug-in for NetSuite. Get WSDL and Schema Tool shows the Get WSDL and Schematool dialog.

Get WSDL and Schema Tool

Getting WSDL and SchemasTo fetch WSDL and schemas from the NetSuite platform, use the Get WSDL and Schema tool.

Procedure

1. In the Project Explorer view, right-click the application module, and click NetSuite Tools > GetWSDL and Schema from the menu that is displayed.

2. Input the WSDL URL in the WSDL field and then click OK.

38


3. The Download Schema dialog is displayed asking you whether to continue to download theschema, click OK.

4. When the WSDL and schemas are downloaded successfully, the WSDL Downloaded Successfullydialog is displayed. Click OK.

Result

The new versions of WSDL and schemas are downloaded to the TIBCO_HOME\BW\palettes\netsuite\version_number\wsdls directory.

39


Customization

You can use custom field, custom record, and custom list in this plug-in.

For more information about cutomization, see NetSuite related documentation on customization.

Custom FieldCustom fields are fields that you can add to your records and transactions to record informationspecific to your business needs.

The custom fields are supported in the NetSuite Record Listener, NetSuite Add Record, NetSuiteUpdate Record, NetSuite Upsert Record, NetSuite Delete Record, NetSuite Get Record, NetSuite SearchRecord, and NetSuite Invoke SavedSearch activities.

If you select the record type that includes custom fields in the General tab, the customFieldList nodewill be displayed in the Input tab.

Each type of custom field includes the @internalId element, which is the ID of the custom field. Oneof the following fields is required in the custom fields:

● @internalId

● @scriptId

If values in both of the fields are given, the value in the @internalId element will be used to customfields.

40


Custom RecordCustom records are entry forms based on existing record types, but customized to include fields forgathering information specific to the needs of your business.

The custom records are supported in the NetSuite Add Record, NetSuite Update Record, NetSuiteUpsert Record, NetSuite Delete Record, NetSuite Get Record, NetSuite Search Record, and NetSuiteInvoke SavedSearch activities.

If you want to process a custom record:

● For the NetSuite Search Record activity, select Setup from the Record Category list, selectCustomization from the Record Subcategory list, and select CustomRecordSearch from the SearchRecord list in the General tab.

● For the NetSuite Invoke SavedSearch activity, select Setup from the Record Category list, selectCustomization from the Record Subcategory list, and select CustomRecordSearchAdvanced fromthe Search Record list in the General tab.

● For other activities, select Setup from the Record Category list, select Customization from theRecord Subcategory list, and select CustomRecord from the Record list in the General tab.

Custom ListA custom list is a list of values that you can use in custom fields on your forms and records.

Custom lists allow you to set up predefined choices for your employees and customers to select whenentering transactions and records.

The custom lists are supported in the NetSuite Add Record, NetSuite Update Record, NetSuite UpsertRecord, NetSuite Delete Record, NetSuite Get Record, and NetSuite Search Record activities.

If you want to process a custom record:

● For the NetSuite Search Record activity, select Setup from the Record Category list, selectCustomization from the Record Subcategory list, and select CustomListSearch from the SearchRecord list in the General tab.

● For other activities, select Setup from the Record Category list, select Customization from theRecord Subcategory list, and select Customlist from the Record list in the General tab.

41


Proxy Settings

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite supports plug-in HTTP proxy property andJava HTTP proxy property settings at design time and runtime.

Two groups of proxy properties are provided by the plug-in.

Group Property Description

Java HTTP proxyproperties

http.proxyHost Required. The proxy hostname or its IP address.

http.proxyPort Required. The port on whichthe proxy service is listening.

http.proxyUser Optional. The username forlogging on to the proxy server.

http.proxyPwd Optional. The password forlogging on to the proxy server.

http.proxyTimeout Optional. The timeout value inminutes for an HTTP call.

This property is to help avoidlong wait times whenattempting to retry through aproxy.

Plug-in HTTP ProxyProperties

com.tibco.bw.palette.netsuite.proxyHost Required. The proxy hostname or its IP address.

com.tibco.bw.palette.netsuite.proxyPort Required. The port on whichthe proxy service is listening.

com.tibco.bw.palette.netsuite.proxyUser Optional. The username forlogging on to the proxy server.

com.tibco.bw.palette.netsuite.proxyPwd Optional. The password forlogging on to the proxy server.

com.tibco.bw.palette.netsuite.proxyTimeout

Optional. The password forlogging on to the proxy server.

This property is to help avoidlong wait times whenattempting to retry through aproxy.

42


Set Proxy at Design TimeYou can set proxy at design time in TIBCO Business Studio.

Procedure


2. Click Window > Preferences in TIBCO Business Studio.

3. In the Preferences dialog, expand General and then click Network Connections in the left panel, asshown in Network Connections.

Network Connections

4. From the Active Provider list, select Manual.

43


5. From the Proxy entries panel, click HTTP and then click Edit, as shown in Proxy Entry Editing.

Proxy Entry Editing

6. Specify values for each field and then click OK.

Set Proxy at RuntimeThe plug-in supports proxy settings at runtime in TIBCO Business Studio.

Procedure


2. Click Run > Run Configurations.

44


3. In the Run Configurations dialog, click the Arguments tab on the left panel, as shown in RunConfigurations.

Run Configurations

4. Input the following arguments and their values in the VM arguments panel:

● -Dcom.tibco.bw.palette.netsuite.proxyHost=192.168.81.20

● -Dcom.tibco.bw.palette.netsuite.proxyPort=808

● -Dcom.tibco.bw.palette.netsuite.proxyUser=yangjia-dt

● -Dcom.tibco.bw.palette.netsuite.proxyPwd=yangjia

● -Dcom.tibco.bw.palette.netsuite.proxyTimeout=3000

The values specified for the arguments in the previous list are an example, you need toreplace the argument values with your own data.

5. Click Apply.

6. In TIBCO Enterprise Administrator at runtime, navigate to the TIBCO_HOME/bw/6.0/bin directoryand open the bwcommon.tra file.

45


7. Add the following arguments and their responding values to the java.extended.propertiesproperty:

-Dcom.tibco.bw.palette.netsuite.proxyHost=192.168.81.20 -

Dcom.tibco.bw.palette.netsuite.proxyPort=808 -

Dcom.tibco.bw.palette.netsuite.proxyUser=yangjia-dt -

Dcom.tibco.bw.palette.netsuite.proxyPwd=yangjia -

Dcom.tibco.bw.palette.netsuite.proxyTimeout=3000

You need to replace the values of the arguments with your own data.

46


The NetSuite Record Listener Activity Configuration

The NetSuite Record Listener activity listens to user events triggered on a specified record. Someconfigurations are needed before using this activity.

The configuration of the NetSuite Record Listener activity you may require the following:

● Preconfiguration on the Activity● Enumeration Transformation● Host Name Checking

Preconfiguration on the ActivityBefore using the NetSuite Record Listener activity, you need to preconfigure an environment.

This activity requires you to preconfigure an environment meeting the following criteria:

● In order to receive messages published from the NetSuite system, this activity must be activelylistening on a server hosted in the demilitarized zone (DMZ) of your enterprise intranet.

To successfully listen for and receive messages:

● The server hosted in the DMZ must be registered with the NetSuite system by using aconfiguration file.

● The SuiteScript that captures the events and publishes the messages must be bound toappropriate records you want to listen to.

It supports listening to messages on multiple DMZ servers, which means you can configuremultiple DMZ servers in the configuration file and the activity will receive messages on all the DMZservers at the same time.

For more information about the configuration tasks, see the chapter that describes post-installationin TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Installation.

● This activity supports both the HTTP and HTTPS communication modes between the NetSuiteRecord listener activity and the NetSuite system for receiving user event messages.

To use HTTPS, you need to generate a keystore file in JKS format that contains a valid certificationfor the embedded HTTPS listener. This valid certification should be authorized from the third-party.

Enumeration TransformationFor the NetSuite Record Listener activity, if the value in an enumeration type does not match theschema definition in WSDL, you can transform the value to a valid enumeration value.

If you want to match a value in an enumeration type to schema definition in WSDL, the value in theNotificationRecordUIValueToSchemaEnumMapping.xml enumeration mapping file, which is locatedin the TIBCO_HOME/bw/palettes/netsuite/version_number/wsdls directory, is used to transformthe value to a valid enumeration value.

This file is only valid when the com.tibco.bw.palette.netsuite.enumeration.validate parameteris set to true, namely:

com.tibco.bw.palette.netsuite.enumeration.validate=true

For how to set the com.tibco.bw.palette.netsuite.enumeration.validate parameter, see SetProxy at Runtime for related information.

47


Host Name CheckingFor the NetSuite Record Listener activity, you can set a parameter to check a specified host name atruntime.

If you want to check the incoming host name, set the host name to the following parameter:

com.tibco.bw.palette.netsuite.match.hostname

For example:

com.tibco.bw.palette.netsuite.match.hostname=www.netsuite.com

You can set more than one host names to the parameter by using the semicolon (;) to separate them, forexample:

com.tibco.bw.palette.netsuite.match.hostname=www.netsuite.com;

23.61.194.178;23.61.194.178;192.168.1.100

For how to set the parameter, see Set Proxy at Runtime for related information.

48


Working with Sample Projects

Working through the sample project helps you understand how TIBCO ActiveMatrix BusinessWorksPlug-in for NetSuite works.

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite packages the NetSuite sample project withinthe installer. The sample project is located in the TIBCO_HOME\bw\palettes\version_number\samples directory.

The NetSuite sample project contains the following processes:

● The Add_Update_Get_Delete Process shows how to add, update, retrieve, and delete theCalendarEvent record from the NetSuite system.

● The GetAll Process shows how to retrieve all the records that match the CampaignAudience recordtype in the NetSuite system.

● The Search_Paging Process shows how to search the AssemblyBuild record to return a large numberof records.

● The Upsert_Delete Process shows how to add, update records, and delete the CalendarEventrecords from the NetSuite system.

● The InvokeSavedSearch_paging Process shows how to retrieve and execute the search queries forthe Account record that are created and saved in the NetSuite system.

● The Record_Listener Process shows how to listen to the Create, Edit, and Delete user eventstriggered on the Event record and then publish an XML message.

Importing the Sample ProjectA sample project is packaged with the plug-in. Before running the project, you need to import theproject to TIBCO Business Studio.

Procedure


2. Click File > Import.

3. In the Import dialog, expand the General folder and select the Existing Studio Projects intoWorkspace item. Click Next.

4. Click Browse next to the Select archive file field to locate the netsuite_sample_project.zipsample file. Click Finish.The sample project is located in the TIBCO_HOME\bw\palettes\netsuite\version_number\samples directory.

Result

The sample projects are imported to TIBCO Business Studio.

Configuring the NetSuite Connection Shared ResourceAll the processes in the sample project require a NetSuite Connection. You must configure the NetSuiteConnection shared resource packaged in the sample before running the processes.

Procedure

1. Expand the NetSuiteSample project in the Project Explorer view.

49


2. Expand the NetSuiteSample node and click Resources > netsuitesample.

3. Double-click NetSuiteConnectionResource.netsuiteConnectionResource.

4. Configure the fields in the NetSuite Connection Configuration tab of the NetSuite Connectionshared resource.

5. Click Test Connection to validate the connection.

Working with the InvokeSavedSearch_paging ProcessThe InvokeSavedSearch_paging process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-infor NetSuite to retrieve and execute the search queries for the Account record that are created andsaved in the NetSuite system.

This process uses the group function to iterately retrieve and execute the search queries in the NetSuitesystem.

Prerequisites

Before running the process, you need to complete the following steps:

1. Importing the Sample Project.

2. Configuring the NetSuite Connection Shared Resource.

Procedure


2. Expand Processes > netsuitesample.

3. Double-click InvokeSavedSearch_paging.bwp.

4. Right-click the Invoke Saved Search activity in Process Editor, and select Show Properties Viewfrom the menu that is displayed.

5. Configure the Invoke Saved Search activity. Click Fetch Saved Searches to fetch available searchcriteria saved in the NetSuite system.

6. Right-click InvokeSavedSearch.bwp and click Run As > Launch BusinessWorks from the menuthat is displayed.

7. Click the Terminate icon to stop the process.

Working with the Record_Listener ProcessThe Record_Listener process shows how to listen to the Create, Edit, and Delete user events triggeredon the Event record and then publish an XML message encapsulating the data of the record on whichthe event was triggered.

Prerequisites




Procedure


50


2. Configure the HTTP Connector shared resource.

1. Expand the NetSuiteSample node and click Resources > netsuitesample.

2. Double-click HTTPConnectorResource.httpConnectionResource.

3. Specify the Host and Port fields in the Basic Configuration tab.

Make sure the values of the <httpServer> and <httpPort> elements in theRecordListenerHTTPConfig.xml file, which you uploaded to the NetSuite website,are consistent with the values specified in the Host and Port fields respectively.


4. Double-click Record_Listener.bwp.

5. Right-click the Record Listener activity in Process Editor and select Show Properties View from themenu that is displayed.

6. Configure the Record Listener activity.

Make sure the values of the <httpPath>, <listenerUsername>, and <listenerPassword>elements in the RecordListenerHTTPConfig.xml file, which you uploaded to theNetSuite website, are consistent with the values specified in the Relative Path, Username,and Password fields respectively.

7. Right-click Record_Listener.bwp in the Project Explorer view and click Run As > LaunchBusinessWorks from the menu that is displayed.

8. Deploy the Event record in the script that you created in the NetSuite system and then add, update,or delete the Event record in the NetSuite system.

See "Running Scripts in NetSuite" in TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuiteInstallation for how to create a script in the NetSuite system.


Result

The Record_Listener process listens to the user events triggered on the Event record, and you can seethe operation you did in the eventType element in the Output tab of the Record Listener activity.

Working with Other ProcessesThe Add_Update_Get_Delete, GetAll, Search_Paging, and Upsert_Delete processes all have similarsteps to perform.

Prerequisites




Procedure



3. Right-click the processs you want to run and click Run As > Launch BusinessWorks from the menuthat is displayed.


51


Description of the Add_Update_Get_Delete ProcessThe Add_Update_Get_Delete process uses transaction activities to add, update, retrieve, and delete theCalendarEvent record from the NetSuite system.

The process is designed with the following activities:

Activity Description

NetSuite Add Record Adds new records to the NetSuite system.

NetSuite UpdateRecord

Updates records to the NetSuite system.

NetSuite Get Record Retrieves records from the NetSuite system.

NetSuite DeleteRecord

Deletes records from the NetSuite system.

Description of the GetAll ProcessThe GetAll process retrieves all the records that match the CampaignAudience record type in theNetSuite system.


52



NetSuite GetAllRecords

Retrieves all the records that match the specified record type in theNetSuite system.

Description of the Search_Paging ProcessThe Search_Paging process searches the AssemblyBuild record when the search criteria is a largenumber of records.


You can define the maximum number of records for each page and use the group function to iterativelysearch all the records that match the search conditions.

53



NetSuite Search Record Searches records when thesearch criteria is expected toreturn a large number ofrecords.

Description of the Upsert_Delete ProcessThe Upsert_Delete process adds, updates records and then deletes the CalendarEvent record from theNetSuite system.


This process uses the group function to iterately add and update records in the NetSuite system.


NetSuite UpsertRecord

Adds and updates records to the NetSuite system.

NetSuite DeleteRecord

Deletes records from the NetSuite system.

54


Managing Logs

Logs are used to trace and troubleshoot exceptions. The plug-in allows users to set up log levels andexport logs.

A logback.xml file is located in the TIBCO_HOME\bw\6.0\config\design\logback directory, you canupdate this file to Setting Up Log Levels and Exporting Logs to a File.

Log LevelsThe plug-in captures logs at different levels.

Log Level Description

ERROR Indicates that an unrecoverable error occurs. Depending on the error severity,the plug-in may continue with the next operation or may stop altogether.

If the ERROR log level is selected, logs only in the ERROR level willbe captured.

WARN Indicates that an abnormal condition is found. Processing will continue, butspecial attention from an administrator is recommended.

If the WARN log level is selected, logs in the ERROR and WARNlevels will be captured.

INFO Indicates normal plug-in operations. No action is needed. A tracing messagetagged with Info indicates that a significant processing step is reached andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

If the INFO log level is selected, logs in the ERROR, WARN, andINFO levels will be captured.

DEBUG Indicates a developer-defined tracing message.

If the DEBUG log level is selected, logs in the ERROR, WARN, INFO,and DEBUG levels will be captured.

TRACE Includes all the information regarding the running process.

If the Trace log level is selected, logs in all the levels, ERROR, WARN,INFO, DEBUG, and TRACE will be captured.

Setting Up Log LevelsBy default, the log level is Error. You can change the log level to trace different messages.

If neither the plug-in log nor the BusinessWorks log is configured in the logback.xml file, the errorlogs of the plug-in will be displayed in the Console view by default.

If the plug-in log is not configured but the BusinessWorks log is configured in the logback.xml file, theconfiguration for BusinessWorks log is implemented by the plug-in.

55


Procedure

1. Navigate to the TIBCO_HOME\bw\6.0\config\design\logback directory and open thelogback.xml file.

2. Add the following node in the User loggers area to specify the log level for the plug-in.<logger name="com.tibco.bw.palette.netsuite.runtime"> <level value="DEBUG"/></logger>

The level tag defines the log level and the value can be Error or Debug.

When the level is set to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

3. Add the following node in User loggers area to specify the log level for an activity.<logger name="com.tibco.bw.palette.netsuite.runtime.ActivityNameActivity"> <level value="DEBUG"/></logger>

For the activities that do not configure with specific log levels, they still inherit log levelconfigured for the plug-in or BusinessWorks.

For example, if you want to set the log level of the Add Record activity to Debug, you need to addthe following node:<logger name="com.tibco.bw.palette.netsuite.runtime.AddRecordActivity"> <level value="DEBUG"/></logger>

For the NetSuite Record Listener activity, the node added in Console Appender area isdifferent.<logger name="com.tibco.bw.palette.netsuite.runtime.RecordListenerEventSource"> <level value="DEBUG"/></logger>

4. Save the file.

Exporting Logs to a FileYou can export the plug-in logs to a file by modifying the logback.xml file.

Procedure

1. Navigate to the TIBCO_HOME\bw\6.0\config\design\logback directory and open thelogback.xml file.

When deploying an application in TIBCO Enterprise Administrator, you need tonavigated to the TIBCO_HOME\bw\domains\mydomain\appnodes\myspace\mynodedirectory to find the logback.xml file.

2. Add the following node to specify the file location.<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-netsuite.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The file tag defines the location to which the log is exported and the value is the absolute path ofthe file that is detailed to the file name.

56


3. Add the following node to the root node at the bottom of the logback.xml file to enable exportingthe logs to a file.<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

57


Error Codes

The exceptions that are thrown by the plug-in are listed with corresponding descriptions andresolutions.

Error Code and ErrorMessage Role Category Description Resolution

TIBCO-BW6-NetSuite-100000

Common error:{0}.

errorRole BW-Plug-in An error ocurredwhen you configuredthe plug-in at designtime.

No action.


Please select the

NetSuite Shared

Connection for {0}.

errorRole BW-Plug-in An error ocurredwhen you did notspecify a NetSuiteConnection sharedresource for theactivity.

Specify aNetSuiteConnectionshared resourcefor the activity.


Error occurred while

logging in: {0}.

errorRole BW-Plug-in An error ocurredduring login to theNetSuite System.

Reconfigure theNetSuiteConnectionshared resource,and test theconnection.


Exception occurred

in execution of

activity

{0},details:{1}.

errorRole BW-Plug-in An error occurredwhen running theactivity.

No action.


Plugin local

exception: {0}.

errorRole BW-Plug-in An exception isthrown due to aninternal plug-in error.

No action.


NetSuite server

exception: {0}.

errorRole BW-Plug-in An exception isthrown due to theNetSuite serverinternal error.

No action.


NetSuite event

source exception:

{0}.

errorRole BW-Plug-in An exception isthrown when runningthe NetSuite RecordListener activity.

No action.

58


Error Code and ErrorMessage Role Category Description Resolution


configuration

error,please check

the configuration.

errorRole BW-Plug-in Errors inconfigurationparameters for theactivity.

Please check theactivityconfiguration.


Parsing the

Authorization HTTP

header information

throw exception:{0}.

errorRole BW-Plug-in A error occurredwhen parsing theauthorization HTTPheard information.

No action.


Error occured when

process the xml

data,details:{0}.

errorRole BW-Plug-in A error occurredwhen processing theXML data

No action.

59


tibco activematrix businessworks plug-in for netsuite user ... activematrix businessworks plug-in...

Documents