PiRemovalTask.historyOnly

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Indicates whether the PI removal task removes system note information only, not field values or workflow history. If true, the task removes information from system notes only. If false, the task removes information from system notes, workflow history, and field values. The default value is false.

Type

boolean (read-only)

Module

N/piremoval Module

Parent Object

piremoval.PiRemovalTask

Sibling Object Members

PiRemovalTask Object Members

Since

2019.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/piremoval Module Script Sample.

            // Add additional code
...
var myPiRemovalTask = piremoval.createTask({
    recordType: 'customer',
    recordIds: [95],
    fieldIds: ['email'],
    historyOnly: true,
    historyReplacement: 'removed_value'
});

myPiRemovalTask.save();
var theHistoryOnly = myPiRemovalTask.historyOnly;
...
// Add additional code

Syntax

Related Topics