tibco activematrix businessworks plug-in for …tibco activematrix businessworks plug-in for...

TIBCO ActiveMatrixBusinessWorks™ Plug-in forNetSuite

User’s GuideSoftware Release 1.0September 2013

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND ANAGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws andtreaties. No part of this document may be reproduced in any form without the written authorization of TIBCOSoftware Inc.TIBCO, Two-Second Advantage, TIBCO Designer, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator,TIBCO Rendezvous, TIBCO Runtime Agent, and TIBCO Hawk are either registered trademarks or trademarksof TIBCO Software Inc. in the United States and/or other countries.Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition(J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporationin 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, NOT ALLOPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFICOPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDINGBUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite User’s Guide

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiTIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Overview of NetSuite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Overview of the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 Get WSDL&Schema Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Overview of WSDL and Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Overview of Get WSDL&Schema Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Getting WSDL and Schemas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 3 NetSuite Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

NetSuite Shared Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

NetSuite Record Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

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


iv | Contents

Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

NetSuite Update Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

NetSuite Upsert Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

NetSuite Delete Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

NetSuite Get Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

NetSuite GetAll Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

NetSuite Search Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

NetSuite Invoke SavedSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 4 Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Custom Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Custom Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47


Contents | v

Custom List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapter 5 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Configuring NetSuite Shared Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Creating a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Adding Activities to a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Testing a Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Appendix A Configuring Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Configuring Plug-in Installation Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Appendix B Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67


vi | Contents


Figures | vii

Figures

Figure 1 Get WSDL&Schema Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Figure 2 NetSuite Plug-in Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Figure 3 Paging Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Figure 4 CustomFieldList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Figure 5 TIBCO Designer Start Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Figure 6 TIBCO Designer Save Project Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52


viii | Figures


Tables | ix

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Table 2 NetSuite Shared Connection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Table 3 NetSuite Record Listener Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Table 4 NetSuite Record Listener Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Table 5 NetSuite Record Listener Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Table 6 NetSuite Add Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Table 7 NetSuite Add Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Table 8 NetSuite Add Record Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Table 9 NetSuite Add Record Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Table 10 NetSuite Update Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Table 11 NetSuite Update Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 12 NetSuite Update Record Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 13 NetSuite Update Record Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 14 NetSuite Upsert Record Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 15 NetSuite Upsert Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 16 NetSuite Upsert Record Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 17 NetSuite Upsert Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 18 NetSuite Delete Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Table 19 NetSuite Delete Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Table 20 NetSuite Delete Record Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Table 21 NetSuite Delete Record Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Table 22 NetSuite Get Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Table 23 NetSuite Get Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Table 24 NetSuite Get Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Table 25 NetSuite Get Record Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Table 26 NetSuite GetAll Records Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 27 NetSuite GetAll Records Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 28 NetSuite GetAll Records Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34


x | Tables

Table 29 NetSuite Search Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Table 30 NetSuite Search Record Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Table 31 NetSuite Search Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Table 32 NetSuite Search Record Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Table 33 NetSuite Invoke SavedSearch Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Table 34 NetSuite Invoke SavedSearch Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Table 35 NetSuite Invoke SavedSearch Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Table 36 NetSuite Invoke SavedSearch Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Table 37 Log Parameters Plug-in Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60


| xi

Preface

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite, integrated with TIBCO ActiveMatrix BusinessWorks, is designed to listen to, add, update, upsert, delete, and query your enterprise data hosted on the NetSuite cloud platform. It is assumed that you are familiar with the basic concepts of the TIBCO environment and the NetSuite system.

Topics

• Related Documentation, page xii

• Typographical Conventions, page xiii

• Connecting with TIBCO Resources, page xv


xii | Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite DocumentationThe following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite documentation set:

• TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Installation Read this manual for instructions on site preparation and installation.

• TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite User’s Guide Read this manual for instructions on using the product.

• TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release.

Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products:

• TIBCO Designer™

• TIBCO Administrator™

• TIBCO ActiveMatrix BusinessWorks™

• TIBCO Rendezvous®

• TIBCO Hawk®

• TIBCO Runtime Agent™


Preface | xiii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

TIB_NSBW_HOME

TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu.

• Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME.

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite installs into a directory within a TIBCO_HOME. This directory is referenced in documentation as TIB_NSBW_HOME. The default value of TIB_NSBW_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\bw\plugins\netsuite.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code

font Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are of particular interest.

• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]


xiv | Typographical Conventions

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName

Key combinations

Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use


Preface | xv

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access TIBCO DocumentationYou can access TIBCO documentation here:

http://docs.tibco.com

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, contact TIBCO Support as follows:

• 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 can request one.

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

https://support.tibco.com

http://docs.tibco.com

http://www.tibcommunity.com


xvi | Connecting with TIBCO Resources


| 1

Chapter 1 Introduction

This chapter gives an overview of NetSuite and TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite.

Topics

• Overview of NetSuite, page 2

• Overview of the Plug-in, page 3


2 | Chapter 1 Introduction

Overview of NetSuite

NetSuite is a cloud-based integrated business management software. 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’s website.


Overview of the Plug-in | 3

Overview of the Plug-in

TIBCO BusinessWorks is an easy-to-use integration software that provides world-class integration technology in a rapidly deployable solution that manages the entire lifecycle of integration projects.

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

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

• The NetSuite Record Listener activity is used to listen to the Create, Edit, and Delete user events triggered on a specified record and publish an XML message encapsulating the data of the record on which 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.


4 | Chapter 1 Introduction


| 5

Chapter 2 Get WSDL&Schema Tool

This chapter specifies how to use the Get WSDL&Schema tool to fetch WSDL and schemas from NetSuite platform.

Topics

• Overview of WSDL and Schemas, page 6

• Overview of Get WSDL&Schema Tool, page 7

• Getting WSDL and Schemas, page 8


6 | Chapter 2 Get WSDL&Schema Tool

Overview of WSDL and Schemas

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

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

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

NetSuite provides several versions of SuiteTalk WSDL and schemas. Version v2013_1_0 is shipped with this plug-in. After installation, you can find it in the TIB_NSBW_HOME\wsdls directory.

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


Overview of Get WSDL&Schema Tool | 7

Overview of Get WSDL&Schema Tool

The Get WSDL&Schema tool is used to fetch WSDL and schemas from the NetSuite platform. It requires you to download WSDL and schemas through full URL of the endpoint.

The Get WSDL&Schema tool is deployed on your machine after installing TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite. Figure 1 shows the Get WSDL&Schema tool dialog.

Figure 1 Get WSDL&Schema Tool


8 | Chapter 2 Get WSDL&Schema Tool

Getting WSDL and Schemas

To fetch WSDL and schemas from the NetSuite platform, follow these steps:

1. Start TIBCO Designer.

2. Select Tools > NetSuite Tools > Get WSDL&Schema from the menu bar. The Get WSDL&Schema tool dialog is displayed.

3. Input the WSDL URL in the WSDL URL field, and then click the OK button.

4. The Download Schema... dialog is displayed asking you whether to continue, click the Yes button.

5. When the WSDL and schemas are downloaded successfully, the WSDL Downloaded Successfully dialog will be displayed. Click the OK button to finish.

The new versions of WSDL and schemas are downloaded to the TIB_NSBW_HOME\wsdls directory.


| 9

Chapter 3 NetSuite Palette

This chapter specifies the NetSuite palette, which includes a shared resource and several activities. After you go through this chapter, you will be familiar with the functions provided by TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite.

Topics

• Palette Overview, page 10

• NetSuite Shared Connection

• NetSuite Record Listener, page 13

• NetSuite Add Record, page 18

• NetSuite Update Record, page 21

• NetSuite Upsert Record, page 24

• NetSuite Delete Record, page 27

• NetSuite Get Record, page 30

• NetSuite GetAll Records, page 33

• NetSuite Search Record, page 35

• NetSuite Invoke SavedSearch, page 40


10 | Chapter 3 NetSuite Palette

Palette Overview

The NetSuite palette is in the Palettes panel. This palette includes one shared resource and nine activities, as shown in Figure 2.

Figure 2 NetSuite Plug-in Palette


NetSuite Shared Connection | 11

NetSuite Shared ConnectionShared Resource

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

The NetSuite Shared Connection shared resource only supports HTTPS connection.

ConfigurationThe Configuration tab contains the following fields.

Table 2 NetSuite Shared Connection Configuration

Field Global Var? Description

Name Yes (Required) The name of the shared resource. The default value is Netsuite Shared Connection.

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

Click the button to add the description in the Description dialog.

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

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

Account Information

Note: If the login email and login password you input are correct, the information of the account can be automatically displayed in the following fields after you click the Retrieve Account Information button.

Login Account No (Required) The account number.

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

Endpoint Version

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

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



Retrieve Account Information Button

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

Test Connection Button

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


NetSuite Record Listener | 13

NetSuite Record ListenerActivity

The NetSuite Record Listener activity is used 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.

It supports custom fields except for the Custom Transaction Item Options. See Chapter 4, Customization, on page 45 for more information.

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 actively listening on a server hosted in the demilitarized zone (DMZ) of your enterprise intranet.

To successfully listen for and receive the messages:

— The server hosted in the DMZ must be registered with the NetSuite system by using a configuration file.

— The SuiteScript that captures the events and publishes the messages must be bound to appropriate records you wish to listen to.

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

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

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

To use HTTPS, you need to complete the following tasks:

— Add the following java security property to the designer.tra file, which is located in the TIBCO_HOME\designer\version_number\bin directory.java.property.com.tibco.security.EntrustLast true

— Generate a keystore file in JKS format for the embedded HTTPS listener.

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




Table 3 NetSuite Record Listener Configuration


Name No (Required) The name of the activity in the process definition. The default value is NetSuite Record Listener.

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


NetSuite Connection

No (Required) Specifies a shared connection resource.

Click the button to open the Select A Resource dialog. All usable NetSuite Connection shared resources are listed in the dialog. Select one to apply to your current activity.

Record Category

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

Record SubCategory

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

Record No (Required) Specifies the record type. If you select the Select All option, it indicates that all of the records in the specified subcategory will be listened to.

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

• Select ALL—triggered only when the specified record is created, edited, or deleted.

• 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 this field in the NetSuite system. See the section that describes the running script in TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Installation.



MiscThe Misc tab allows you to configure features that are common to all process starters. See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information about this tab.

The values in the following fields must be consistent with the ones in the corresponding fields in the RecordListenerHTTPConfig.xml file, which is located in the TIB_NSBW_HOME\suitescript directory.

Host Name Yes (Required) Specifies the host name or IP address of the DMZ server.

Listener Port Yes (Required) Specifies the port number of the DMZ server.

Listener Username

Yes (Required) Specifies 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 username 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 will receive the messages triggered by the user event.

Listener Password

Yes (Required) Specifies the password that is used to pass the basic authentication of the runtime Record Listener activity.

Use SSL No (Optional) Check this checkbox to use SSL to support the communication between the NetSuite system and this activity.

Note: If you have checked this checkbox, you need to specify the keystore file and keystore password in the following two fields.

The following fields are displayed when you check the Use SSL checkbox.

Keystore File Yes The full path of the keystore file used for the SSL transport.

Click the button to select the keystore file.

Keystore Password

Yes The password used to access the keystore file.

Table 3 NetSuite Record Listener Configuration (Cont’d)




OutputThe output for the activity is as follows.

Table 4 NetSuite Record Listener Output

Output Item Data Type Description

eventType string The type of the event. Possible values are: Add, Edit, and Delete.

recordName string The name of the record on which the event was raised.

recordInternalID string The name 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 NetSuite.

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 with different record types. For the meaning of each attribute, see the NetSuite documentation.

Note: In some cases, some of the field values that cannot be retrieved by the SuiteScript API will not be included in the output tab.



Error OutputThe Error Output tab lists the exception that can be thrown by this activity.

Table 5 NetSuite Record Listener Exceptions

Exception Cause

NetSuitePluginException Occurs when the plug-in has internal errors.



NetSuite Add RecordActivity

The NetSuite Add Record activity is used to add new records to the NetSuite system. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity supports batch operations, which means you can add multiple records at a time. If you want to add data collection to the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the input fields in the NetSuite Add Record activity.


Table 6 NetSuite Add Record Configuration


Name Yes (Required) The name of the activity in the process definition. The default value is NetSuite Add Record.



NetSuite Connection



Record Category


Record Subcategory


Record No (Required) Specifies the record type.


NetSuite Add Record | 19

InputThe required input of the activity varies with the record type you chose in the Configuration tab. Table 7 specifies the possible input of the activity.


Table 7 NetSuite Add Record Input

Input Item Data Type Description

Records

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

items N/A The attributes of the new record. It varies with different record types.

Note:

• Values for the lastModifiedDate and createdDate fields are generated by the NetSuite system. Values input in these two fields do not take effect.

• When you selected the Transaction > Customers > Charge record type, this activity cannot be executed if you assign values to the chargeType, stage, or use fields.

Table 8 NetSuite Add Record Output Tab

Output Items Data Type Description

Success boolean This property indicates the status of all of the operations. If no error occurs when adding one or more records, the status true is returned.



Error OutputThe Error Output tab lists the exceptions that can be thrown by this activity.

Results

Result

status

@isSuccess boolean This property indicates the status of the current operation. If no error occurs when adding a record, the status true is returned.

statusDetail

@type string The type of the message returned from the NetSuite system; ERROR, WARN, or INFO.

code string The code of the message returned from the NetSuite system.

message string The message returned from the NetSuite system.

baseRef

@internalId string The internal ID of the added records.

@externalId string The external ID of the added records.

@type string The type of the added records.

Table 8 NetSuite Add Record Output Tab (Cont’d)


Table 9 NetSuite Add Record Exceptions

Exception Cause


NetSuiteServerException Occurs when the NetSuite system encounters errors with processing a request from the plug-in.


NetSuite Update Record | 21

NetSuite Update RecordActivity

The NetSuite Update Record activity is used to update records in the NetSuite system. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity supports batch operations, which means you can update multiple records at a time. If you want to update a data collection in the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the input fields in the NetSuite Update Record activity.


Table 10 NetSuite Update Record Configuration


Name Yes (Required) The name of the activity in the process definition. The default value is NetSuite Update Record.



NetSuite Connection



Record Category


Record Subcategory







Table 11 NetSuite Update Record Input


Record

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

@externalId string (Optional) The external ID of the record to be updated. If this field is not empty, its value must be unique in the record type.

items N/A The attributes of the record. It varies with different record types.

Note:



Table 12 NetSuite Update Record Output Tab


Success boolean This property indicates the status of all of the operations. If no error occurs when updating one or more records, the status true is returned.


NetSuite Update Record | 23


Results

Result

status

@isSuccess boolean This property indicates the status of the current operation. If no error occurs when updating a record, the status true is returned.

statusDetail




baseRef

@internalId string The internal ID of the updated records.

@externalId string The external ID of the updated records.

@type string The type of the updated records.

Table 12 NetSuite Update Record Output Tab (Cont’d)


Table 13 NetSuite Update Record Exceptions

Exception Cause





NetSuite Upsert RecordActivity

The 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 the existing record that has the same external ID. Otherwise, a new record will be created in the NetSuite system.

It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity supports batch operations, which means you can upsert multiple records at a time. If you want to upsert a data collection in the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the input fields in the NetSuite Upsert Record activity.


Table 14 NetSuite Upsert Record Configuration


Name No (Required) The name of the activity in the process definition. The default value is NetSuite Upsert Record.



NetSuite Connection



Record Category


Record Subcategory




NetSuite Upsert Record | 25



Table 15 NetSuite Upsert Input


Record

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

items N/A The attributes of the record. It varies with different record types.

Note:



Table 16 NetSuite Upsert Record Output Tab


Success boolean This property indicates the status of all of the operations. If no error occurs when upserting one or more records, the status true is returned.




Results

Result

status

@isSuccess boolean This property indicates the status of the current operation. If no error occurs when upserting a record, the status true is returned.

statusDetail




baseRef

@internalId string The internal ID of the upserted records.

@externalId string The external ID of the upserted records.

@type string The type of the upserted records.

Table 16 NetSuite Upsert Record Output Tab (Cont’d)


Table 17 NetSuite Upsert Exceptions

Exception Cause




NetSuite Delete Record | 27

NetSuite Delete RecordActivity

The NetSuite Delete Record activity is used to delete records from the NetSuite system. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity supports batch operations, which means you can delete multiple records at a time. If you want to delete a data collection from the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the input fields in the NetSuite Delete Record activity.

ConfigurationThe configuration tab contains the following fields.

Table 18 NetSuite Delete Record Configuration


Name Yes (Required) The name of the activity in the process definition. The default value is NetSuite Delete Record.



NetSuite Connection



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

Record Subcategory





InputThe input for the activity is as follows.


Table 19 NetSuite Delete Record Input


baseRef

Note: At least one of the following fields is required. If both of them are given values, the value in the @internalId field is used to delete records.

@internalId string The internal IDs of the records you want to delete from the NetSuite system.

@externalId string The external IDs of the records you want to delete from the NetSuite system.

Table 20 NetSuite Delete Record Output Tab


Success boolean This property indicates the status of all of the operations. If no error occurs when deleting one or more records, the status true is returned.


NetSuite Delete Record | 29


Results

Result

status

@isSuccess boolean This property indicates the status of the current operation. If no error occurs when deleting a record, the status true is returned.

statusDetail




baseRef

@internalId string The internal ID of the deleted records.

@externalId string The external ID of the deleted records.

@type string The type of the deleted records.

Table 20 NetSuite Delete Record Output Tab (Cont’d)


Table 21 NetSuite Delete Record Exceptions

Exception Cause





NetSuite Get RecordActivity

The NetSuite Get Record activity is used to retrieve records from the NetSuite system with internal IDs or external IDs. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity supports batch operations, which means you can retrieve multiple records at a time. If you want to retrieve a data collection from the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the input fields in the NetSuite Get Record activity.


Table 22 NetSuite Get Record Configuration


Name Yes (Required) The name of the activity in the process definition. The default value is NetSuite Get Record.



NetSuite Connection



Record Category


Record Subcategory




NetSuite Get Record | 31

InputThe input for the activity is as follows.


Table 23 NetSuite Get Record Input


baseRef

Note: At least one of the following fields is required. If both of them are given values, the value in the @internalId field is used to retrieve records.

@internalId string The internal IDs of the records you want to retrieve from the NetSuite system.

@externalId string The external IDs of the records you want to retrieve from the NetSuite system.

Table 24 NetSuite Get Record Output


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




status

@isSucess boolean This property indicates the status of the current operations. If no error occurs when retrieving a record, the status true is returned.

statusDetail




Record

@internalId string The internal IDs of the retrieved records.

@externalId string The external IDs of the retrieved records.

item N/A The attributes of the record. It varies with different record types.

Note: If you selected the Transaction > Customers > CustomerRefund record type, the values in the depositList node are displayed in the applyList node.

Table 24 NetSuite Get Record Output (Cont’d)


Table 25 NetSuite Get Record Exceptions

Exception Cause




NetSuite GetAll Records | 33

NetSuite GetAll RecordsActivity

The NetSuite GetAll Records activity is used to retrieve all the records that match the specified record type in the NetSuite system.

ConfigurationThe configuration tab contains the following fields.

InputThis activity has no input.

Table 26 NetSuite GetAll Records Configuration


Name Yes (Required) The name of the activity in the process definition. The default value is NetSuite GetAll Record.



NetSuite Connection



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

Record Subcategory







Table 27 NetSuite GetAll Records Output


RecordCategory string The top level category of the record type you chose in the configuration tab.

RecordSubCategory string The subcategory of the record type you chose in the configuration tab.

RecordType string The record type you chose in the configuration tab.

Success boolean This property indicates the status of all of the operations. If no error occurs when retrieving all records, the status true is returned.

total integer The number of returned records.

Message string The error messages or warning messages returned from the NetSuite system.

Results

Record The attributes of the returned records.

Table 28 NetSuite GetAll Records Exceptions

Exception Cause




NetSuite Search Record | 35

NetSuite Search RecordActivity

The NetSuite Search Record activity is used to search records based on the specified search criteria. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity also supports paging search. See Paging Search on page 37 for more information.


Table 29 NetSuite Search Record Configuration


Name No (Required) The name of the activity in the process definition. The default value is NetSuite Search Record.



NetSuite Connection



Record Category

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

Record Subcategory

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

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

Record Type No (Optional) Specifies the record type.

Note: This field is displayed only when you select the Lists > Accounting > ItemSearch or the Transaction > Sales > TransactionSearch search record type.



InputThe input of the activity varies with the record type you chose in the Configuration tab. Table 30 specifies the possible input of the activity.

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

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

Table 29 NetSuite Search Record Configuration (Cont’d)


Table 30 NetSuite Search Record Input


Page

searchId string The search ID of the last search operation.

It is used for paging search. The value in this field should be mapped from the output searchId of this activity. See Paging Search on page 37 for more information.

pageIndex string The index of the current page.

It is used for paging search. The value in this field should be mapped from the output pageIndex of this activity. See Paging Search on page 37 for more information.

searchRecord

basic N/A The attributes of the specified search record type. For more information about the meaning of attributes, see the NetSuite documentation.

Note: If you selected the Lists > Accounting > SubsidiarySearch search record type in Configuration tab, any input in the state field does not take effect.



Paging Search

Paging search can be used when the search criteria is expected to return a large number of records. You can define the maximum number of records for each page and use the group function to iteratively search all the records that match the search conditions.

Besides, in the input tab of the NetSuite Search Record activity, you need to map the output searchId and pageIndex of this activity from the Process Data panel to the identical fields in the Activity Input panel as input, as shown in Figure 3.

Figure 3 Paging Search

For more information on the group function and mapping data, see TIBCO ActiveMatrix BusinessWorks Process Design Guide.





Table 31 NetSuite Search Record Output


Success boolean This property indicates the status of all of the operations. If no error occurs when searching one or more records, the status true is returned.


SearchResult

totalRecords string The total number of searched records.

pageSize string The maximum number of records that are to be returned on each page. It is the same as the value specified in the Configuration tab.

totalPages string The number of pages.


When using paging search, the value in this field needs to be mapped to the identical field in the input tab as input. See Paging Search on page 37 for more information.

searchId string The search ID of this operation. The value in this field was allocated by the NetSuite system.


RecordList

record N/A The attributes of searched record. For more information about the meaning of attributes, see the NetSuite documentation.



Table 32 NetSuite Search Record Exceptions

Exception Cause





NetSuite Invoke SavedSearchActivity

The NetSuite Invoke SavedSearch activity is used to retrieve and execute the search queries that are created and saved in the NetSuite system. It supports custom fields, custom records, and custom lists, see Chapter 4, Customization, on page 45 for more information.

This activity also supports paging search. This feature can be used when the search criteria is expected to return a large number of records. You can define the maximum number of records for each page 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 Process Design Guide.


Table 33 NetSuite Invoke SavedSearch Configuration


Name No (Required) The name of the activity in the process definition. The default value is NetSuite Invoke SavedSearch.



NetSuite Connection



Record Category

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

Record Subcategory

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

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


NetSuite Invoke SavedSearch | 41

InputThe input of the activity varies with the record type you chose in the Configuration tab. Table 30 specifies the possible input of the activity.

Saved Searches

No (Required) The search criteria for searching records.

Click the button to fetch available search criterias saved in the NetSuite system. The search criterias are filtered based on the search record type.

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

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

Table 33 NetSuite Invoke SavedSearch Configuration (Cont’d)


Table 34 NetSuite Invoke SavedSearch Input


Page

searchId string The search ID of the last search operation.

It is used for paging search. The value in this field should be mapped from the output searchId of this activity. See Paging Search on page 37 for more information.


It is used for paging search. The value in this field should be mapped from the output pageIndex of this activity. See Paging Search on page 37 for more information.





Table 35 NetSuite Invoke SavedSearch Output


Success boolean This property indicates the status of all of the operations. If no error occurs when searching one or more records, the status true is returned.


SearchResult

totalRecords string The total number of searched records.

pageSize string The maximum number of records that are to be returned on each page. It is the same as the value specified in the Configuration tab.

totalPages string The number of pages.



searchId string The search ID of this operation. The value in this field was allocated by the NetSuite system.


searchRowList

searchRow N/A The attributes of searchRow. For more information about the meaning of attributes, see the NetSuite documentation.


NetSuite Invoke SavedSearch | 43

Table 36 NetSuite Invoke SavedSearch Exceptions

Exception Cause




| 45

Chapter 4 Customization

This chapter introduces how to use custom field, custom record, and custom list in this plug-in.

Topics

• Custom Field, page 46

• Custom Record, page 47

• Custom List, page 48


46 | Chapter 4 Customization

Custom Field

Custom fields are fields that you can add to your records and transactions to record information specific to your business needs. For more information about the custom fields, see the NetSuite documentation on customization.

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

If you selected the record type that includes custom fields in the Configuration tab, the customFieldList node can be displayed in the input tab, as shown in Figure 4.

Figure 4 CustomFieldList

Each type of custom field includes the @internalId field, which is the ID of the custom field. The @internalId field is required.


Custom Record | 47

Custom Record

Custom records are entry forms based on existing record types, but customized to include fields for gathering information specific to the needs of your business. For more information about the custom records, see the NetSuite documentation on customization.

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

For the NetSuite Search Record activity, if you want to process a custom record, you should select the Setup > Customization > CustomRecordSearch record type in the Configuration tab of the activity. For other activities, you need to select the Setup > Customization > CustomRecord record type. And then the customFieldList node will be displayed in the input tab or output tab. See Custom Field on page 46 for more information.


48 | Chapter 4 Customization

Custom List

A 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 when entering transactions and records. For more information about custom lists, see the NetSuite documentation on customization.

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

For the NetSuite Search Record activity, if you want to process a custom record, you should select the Setup > Customization > CustomListSearch record type in the Configuration tab of the activity. For other activities, you need to select the Setup > Customization > Customlist record type.


| 49

Chapter 5 Getting Started

This chapter specifies the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite in TIBCO Designer.

Topics

• Overview, page 50

• Creating a Project, page 51

• Configuring NetSuite Shared Connection, page 53

• Creating a Process, page 54

• Adding Activities to a Process, page 55

• Testing a Process, page 56

• Deploying a Project, page 57


50 | Chapter 5 Getting Started

Overview

TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop and test integration projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user interface, TIBCO Designer for defining business processes, and an engine that executes the processes.

For detailed information about how to configure processes, see TIBCO Designer documentation, which can be accessed from the Help > Designer Help menu option in TIBCO Designer.

A typical configuration procedure contains the following steps:

1. Creating a Project, page 51

2. Configuring NetSuite Shared Connection, page 53

3. Creating a Process, page 54

4. Adding Activities to a Process, page 55

5. Testing a Process, page 56

6. Deploying a Project, page 57


Creating a Project | 51

Creating a Project

The TIBCO Designer GUI is used to configure the plug-in. When starting TIBCO Designer, you must create or select a project. A project contains the configuration files that define options used during runtime.

To create a project, complete the following steps:

1. Start TIBCO Designer.

Execute one of the following platform-specific commands to open the TIBCO Designer window:

— On Microsoft Windows

Click Start > All Programs > TIBCO > TIBCO Designer version_number > TIBCO Designer.

Or

From a command window, run TIBCO_HOME\designer\version_number\bin\designer.exe.

— On UNIX

From a command window, run TIBCO_HOME/designer/version_number/bin/designer.

2. Click the New Empty Project button in the TIBCO Designer dialog, as shown in Figure 5. The Save Project dialog appears.

Figure 5 TIBCO Designer Start Screen



3. Click the button in the Multi-File Project tab. Navigate to the location where you intend to save the project and specify a name for the project. Click the OK button to continue, as shown in Figure 6.

Figure 6 TIBCO Designer Save Project Screen

The TIBCO Designer GUI appears with the newly created project.


Configuring NetSuite Shared Connection | 53

Configuring NetSuite Shared Connection

After creating the project, you need to add a NetSuite Shared Connection shared resource and configure it to set up the connections among the plug-in and NetSuite system.

After dragging the NetSuite Shared Connection shared resource from the NetSuite Palette panel to the design panel, you need to configure each field in the Configuration tab. See NetSuite Shared Connection on page 11 for details about the shared resource.



Creating a Process

After getting the metadata in the TIBCO Designer window, you need to create a process to deal with certain workflows.

To create a process, complete the following steps:

1. Select the root directory in the project panel.

2. Expand the Process palette in the palette panel and drag the Process Definition icon into the design panel.

3. Configure the process. For more information, see TIBCO Designer User’s Guide.

4. Click the Apply button to save the configuration.


Adding Activities to a Process | 55

Adding Activities to a Process

After creating the process, you can add the plug-in activities to it.

To add an activity to the process, complete the following steps:

1. Click the process that was previously created in Creating a Process on page 54. The Start and End activities appear in the design panel.

2. Expand the NetSuite palette in the palette panel and drag one or more activities to the design panel. You can also add activities from other palettes to the process, for example, File activities.

3. Create transitions between activities in the design panel.

4. Configure each activity in the process. For configuration information, see NetSuite Palette on page 9.

If the NetSuite palette is not shown in the palette panel, select Palettes > Activities > NetSuite from the menu bar to make it visible.



Testing a Process

After creating and configuring the process, you can test it in TIBCO Designer. This allows you to check if the process works properly before you deploy it. See TIBCO BusinessWorks Process Design Guide for detailed information on using test mode.


Deploying a Project | 57

Deploying a Project

To deploy a project that you have configured, you need to generate an Enterprise Archive file (EAR file) that contains configurations for the process definition you want to deploy. You can upload the archive to TIBCO Administrator to deploy the associated system. See TIBCO ActiveMatrix BusinessWorks Administration for more information.

The following is the basic procedure:

1. Save the project in TIBCO Designer window.

2. Create an enterprise archive and then create a process archive in it.

3. Add processes defined in the project into the process archive.

4. Add the NetSuiteResources folder and the NetSuite Shared Connection applied to the process to the shared archive.

5. Build the archive by clicking the Build Archive button under the Enterprise Archive panel. When you click the button, TIBCO Designer generates an enterprise archive (.ear) file that you can then deploy from TIBCO Administrator.

6. Start TIBCO Administrator and create a system related to the project.

7. Deploy the system and start the process.


| 59

Appendix A Configuring Log Files

This appendix describes how to set the log file to update the tracing options.

Topics

• Configuring Plug-in Installation Log Files, page 60


60 | Appendix A Configuring Log Files

Configuring Plug-in Installation Log Files

This section specifies how to set the log status when configuring a project in TIBCO Designer, or deploying a project in TIBCO Administrator.

Configuring in TIBCO Designer

Tracing options are set in TIBCO Designer when configuring a service or process. You can view the tracing options for a process or service instance and set search parameters to display only a subset of a log file.

When you configure a project in TIBCO designer, write the following lines of code in your configuration file (.cfg file) to set the log status. You may change the value in the file.

Trace.Info.*=true

Trace.Error.*=true

Trace.Warn.*=true

Trace.Debug.*=true

com.tibco.plugin.netsuite.debug=false

com.tibco.plugin.netsuite.info=true

Deploying in TIBCO Administrator

Trace.Info.*, Trace.Error.*, and Trace.Warn.* are three general properties in TIBCO BusinessWorks. They are not added in the default bwengine.xml configuration file located in the TIBCO_HOME\bw\version\lib\com\tibco\deployment directory. If you want to set the log status when deploying a project in TIBCO Administrator, add these properties manually in the bwengine.xml file.

See the TIBCO BusinessWorks Administration documentation for details.

Table 37 shows the description for each log parameter.

Table 37 Log Parameters Plug-in Installation

Property Component Description

Trace.Info.* TIBCO BusinessWorks

Whether the general information is shown (true) or not (false) while running the application.

The default is true.


Configuring Plug-in Installation Log Files | 61

Trace.Error.* TIBCO BusinessWorks

Whether the error message is shown (true) or not (false) while running the application.


Trace.Warn.* TIBCO BusinessWorks

Whether the warning message is shown (true) or not (false) while running the application.


Table 37 Log Parameters Plug-in Installation (Cont’d)

Property Component Description


62 | Appendix A Configuring Log Files


| 63

Appendix B Trace Messages

This appendix lists the error messages used by TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite.

Topics

• TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Error Messages, page 64


64 | Appendix B Trace Messages

TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Error

Messages

BW-NetSuite-12700: The Keystore File was NOT specified.

Role: errorRole

Category: BW-Plugin

Description: An error occurred when the keystore file was not specified for the NetSuite Record Listener activity if the Used SSL checkbox was checked.

Resolution: Specify the keystore file in the keystore file field in the Configuration tab of the NetSuite Record Listener activity.

BW-NetSuite-127003: Cannot find a target server. The address in the incoming message [%1].

Role: errorRole

Category: BW-Plugin

Description: An error ocurred when the current NetSuite Record Listener activity object was not fetched from the HashMap pool.

Resolution: Check whether the host name or IP address specified in the RecordListenerHTTPConfig.xml file is the same as the one specified in the NetSuite Record Listener activity.

BW-NetSuite-134001: [%1].

Role: errorRole

Category: BW-Plugin

Description: An error ocurred when you configure the plug-in at design time.

Resolution: Check errors listed in the error message and take action accordingly.


TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite Error Messages | 65


Role: errorRole

Category: BW-Plugin

Description: An error may occur when calling a remote method.



Role: errorRole

Category: BW-Plugin

Description: An error occurred when you input an invalid value for the activities.


BW-NetSuite-134004: [%1]

Role: errorRole

Category: BW-Plugin

Description: An error occurred when parsing a string, a message, or a configuration file.



Role: errorRole

Category: BW-Plugin

Description: An error occurred when the output is invalid.

Resolution: No action required.


66 | Appendix B Trace Messages


| 67

Index

A

account information 11activities

NetSuite Add Record 3, 18NetSuite Delete Record 3, 27NetSuite Get Record 3, 30NetSuite GetAll Records 3, 33NetSuite Invoke SavedSearch 3, 40NetSuite Record Listener 3, 13NetSuite Search Record 3, 35NetSuite Update Record 3, 21NetSuite Upsert Record 3, 24

C

certificate authorities 13custom field 46custom list 48custom record 47customer support xv

D

DMZ server 13

E

endpoint URL 11endpoint version 11ENV_NAME xiii

G

Get WSDL&Schema tool 7

H

host name 15

K

keystore file 15keystore password 15

L

listener port 15login account 11login email 11login password 11login role 11

P

paging search 35, 40palette overview 10

R

retrieve account information button 12


68 | Index

S

shared resource 11NetSuite Shared Connection 3, 11

SSL 15SuiteTalk Schemas 6SuiteTalk WSDL 6support, contacting xv

T

technical support xvtest connection button 12TIB_NSBW_HOME xiiiTIBCO ActiveMatrix BusinessWorks 50TIBCO Designer 50TIBCO_HOME xiii

U

user eventscreate 13delete 13edit 13

tibco activematrix businessworks plug-in for …tibco activematrix businessworks plug-in for...

Documents