Macro(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Performs a macro operation and returns its result in a plain JavaScript object.

Note:

Substitute Macro with the name of the macro you are executing.

For information about record macros, see Overview of Record Action and Macro APIs.

Returns

{notifications: [], response: {}}

Supported Script Types

Client and server scripts

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

Governance

None

Module

N/record Module

Parent Object

record.Macro

Sibling Object Members

Macro Object Members

Since

2018.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.params

Object

optional

The macro arguments.

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/record Module Script Samples.

          // Add additional code
...
var calculateTax = recordObj.getMacro({id: 'calculateTax'});
calculateTax();
...
// Add additional code 

        

Related Topics

record.Macro
N/record Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices