Join Object Members for SuiteAnalytics in NetSuite

Joining records in SuiteAnalytics allows developers to create complex datasets by leveraging the relationships between various record types. This article details the members of the Join object used in datasets, providing essential details for effective implementation.

What Are Join Object Members?

The Join object encapsulates a joined record that is used within a dataset. Each join can pull data across various record types, which is vital for generating comprehensive reports and insights.

Join Object Members Overview

Here are the key members of the dataset.Join object:

Creating Joins in SuiteAnalytics

To utilize the Join object, you must first create a join using the dataset.createJoin(options) method. Here are some examples of how to create various types of joins:

Basic Join Creation

// Create a basic Join
var myNameJoin = dataset.createJoin({
    fieldId: 'name'
});

Inverse Join Creation

// Create an inverse Join
var myInverseJoin = dataset.createJoin({
    fieldId: 'phone',
    source: 'contact'
});

Polymorphic Join Creation

// Create a polymorphic Join
var myPolymorphicJoin = dataset.createJoin({
    fieldId: 'phone',
    target: 'entity'
});

Multi-level Join Creation

// Create a multi-level Join
var myMultiLevelJoin = dataset.createJoin({
    fieldId: 'phone',
    join: myNameJoin
});

Loading and Auditing the Joined Dataset

You can load a dataset that includes a join and inspect its properties through logging:

1var myDataset = dataset.load({
2    id: myDatasetId    // Replace with a valid ID value for your account
3});
4var myJoin = myDataset.columns[0].join;
5 
6log.audit({
7    title: 'Join fieldId = ',
8    details: myJoin.fieldId
9});
10log.audit({
11    title: 'Join source = ',
12    details: myJoin.source
13});
14log.audit({
15    title: 'Join target = ',
16    details: myJoin.target
17});
18log.audit({
19    title: 'Join join = ',
20    details: myJoin.join
21});

Conclusion

Using join operations effectively in SuiteAnalytics allows access to a broader range of data, enabling deeper insights and better reporting capabilities.

Key Takeaways

• The Join object encapsulates complex data relationships within datasets.
• It supports various join types, including basic, polymorphic, and multi-level joins.
• Understanding join properties is essential for effective data retrieval and reporting.