N/piremoval Module

Use the N/piremoval module to remove personal information (PI) from system notes, workflow history, and specific field values. Use the N/piremoval module to comply with privacy regulations, specifically the right to be forgotten. You can remove personal information from system notes only, or you can also remove workflow history and field values on the record. Entity records, transactions, and custom records are supported.

You can use the piremoval.createTask(options) method to create a PI removal task, or use piremoval.loadTask(options) to load an existing PI removal task. Both of these methods return a piremoval.PiRemovalTask object that represents the task. Create a piremoval.PiRemovalTask object for each record type that requires removal of personal information. Use the PiRemovalTask.save() method to save the task, then use the PiRemovalTask.run() method to process the task and remove the personal information.

You can use the piremoval.getTaskStatus(options) method to check the status of a submitted PI removal task. This method returns a piremoval.PiRemovalTaskStatus object that describes the current status of the removal task. The piremoval.PiRemovalTaskStatus object uses an iterator to provide a list of log entries in the PiRemovalTaskStatus.logList object.

To use the N/piremoval module, the following requirements must be met:

• Remove Personal Information Create permission is required to create a PI removal task.

• Remove Personal Information Run permission is required to run a PI removal task.

For more information, see Personal Information (PI) Removal.

In This Help Topic

• N/piremoval Module Members

• PiRemovalTask Object Members

• PiRemovalTaskLogItem Object Members

• PiRemovalTaskStatus Object Members

N/piremoval Module Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Object	piremoval.PiRemovalTask	Object	Server scripts	Encapsulates a personal information removal task. Use piremoval.createTask(options) to create this object.
	piremoval.PiRemovalTaskLogItem	Object	Server scripts	Encapsulates a log item of the personal information removal task status.
	piremoval.PiRemovalTaskStatus	Object	Server scripts	Encapsulates the status of a personal information removal task. Use piremoval.getTaskStatus(options) to create this object.
Method	piremoval.createTask(options)	piremoval.PiRemovalTask	Server scripts	Creates a personal information removal task.
	piremoval.deleteTask(options)	void	Server scripts	Deletes a personal information removal task.
	piremoval.getTaskStatus(options)	piremoval.PiRemovalTaskStatus	Server scripts	Retrieves the status of a personal information removal task.
	piremoval.loadTask(options)	piremoval.PiRemovalTask	Server scripts	Loads a personal information removal task.

PiRemovalTask Object Members

The following members are available for a piremoval.PiRemovalTask object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Method	PiRemovalTask.deleteTask()	void	Server scripts	Deletes the personal information removal task.
	PiRemovalTask.run()	void	Server scripts	Runs the personal information removal task.
	PiRemovalTask.save()	void	Server scripts	Saves the personal information removal task.
Property	PiRemovalTask.fieldIds	string[] (read-only)	Server scripts	Represents the field IDs that are processed by the PI removal task.
	PiRemovalTask.historyOnly	boolean	Server scripts	Indicates whether the PI removal task removes system note information only, not field values or workflow history.
	PiRemovalTask.historyReplacement	string (read-only)	Server scripts	Represents the text used in system notes to replace the original values.
	PiRemovalTask.id	number (read-only)	Server scripts	Represents the ID of the personal information removal task.
	PiRemovalTask.recordIds	number[] (read-only)	Server scripts	Represents the record IDs that are processed by the PI removal task.
	PiRemovalTask.recordType	string (read-only)	Server scripts	Describes the record type updated by the PI removal task.
	PiRemovalTask.status	piremoval.PiRemovalTaskStatus	Server scripts	Describes the status of the submitted personal information removal task.
	PiRemovalTask.workflowIds	number[] (read-only)	Server scripts	Represents the workflow IDs whose history is processed by the PI removal task.

PiRemovalTaskLogItem Object Members

The following members are available for a piremoval.PiRemovalTaskLogItem object.

Member Type	Name	Return Type/Value Type	Support Script Type	Description
Property	PiRemovalTaskLogItem.exception	string (read-only)	Server scripts	Describes the exception for the log item, including and what caused it.
	PiRemovalTaskLogItem.message	string (read-only)	Server scripts	Describes the message for the log item and an explanation for any errors.
	PiRemovalTaskLogItem.status	string (read-only)	Server scripts	Describes the status of the log item. This property takes its values from task.TaskStatus.
	PiRemovalTaskLogItem.type	string (read-only)	Server scripts	Describes the type of personal information that was removed, one of FieldValue, SystemNote, or Workflow.

PiRemovalTaskStatus Object Members

The following members are available for a piremoval.PiRemovalTaskStatus object.

Member Type	Name	Return Type/Value Type	Support Script Type	Description
Property	PiRemovalTaskStatus.logList	list	Server scripts	Represents a list of logs for the PI removal task job.
	PiRemovalTaskStatus.status	string	Server scripts	Describes the status of the submitted personal information removal task.

Related Topics

SuiteScript 2.x Modules

Personal Information (PI) Removal

General Notices