Column.join

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Join ID for a search column as a string.

Type

string (read-only)

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/search Module

Since

2015.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/search Module Script Samples.

          // Add additional code
...
// Create a joined column. The name parameter is a field name on
// the joined record type, and the join parameter is a field name
// on the base record type that references the joined record type.
//
// In this example, a search is created for customer records.
// Customer records include a 'salesrep' field, which references an
// employee record. This joined column represents the value of the
// 'firstname' field on the referenced employee record.
var myColumn = search.createColumn({
    name: 'firstname',
    join: 'salesrep'
});

var mySearch = search.create({
    type: search.Type.CUSTOMER,
    columns: [
        'entityid',
        'email',
        myColumn
    ]
});

var theJoin = myColumn.join;
...
// Add additional code

Syntax

Related Topics