Hide Body Fields and Sublist Columns on Transaction Forms

Script Summary

For more information about script types and entry points, see SuiteScript 2.1 Script Types.

The Complete Script

This tutorial includes the complete script. The complete script is provided below so that you can copy and paste it into your text editor and save the script as a .js file (for example, <add an example filename - start with the script type abbreviation, such as 'ue_this_script;>.js).

              /**
* @NApiVersion 2.1
* @NScriptType UserEventScript
*/
define(['N/runtime'], (runtime) => {

/*
* Parameter constraints accommodated:
* - Labels <= 25 chars (you choose labels in UI; suggestions below)
* - IDs <= 30 chars (the IDs below are <= 30)
*
* Create these PARAMETERS on the Script record (then set per deployment):
*
* 1) Roles (optional)
*    ID: custscript_hf_roles
*    Example: 1019,1050
*
* 2) Forms (optional)
*    ID: custscript_hf_forms
*    Example: 123,456
*
* 3) Body Flds (optional)
*    ID: custscript_hf_body
*    Example: memo,custbody_myfield
*
* 4) Sublists (optional)
*    ID: custscript_hf_sublists
*    Example: item,expense
*
* 5) Sublist Flds (optional)
*    ID: custscript_hf_subflds
*    Example: taxdetailsreference,custcol_mycol
*/

const P_ROLES   = 'custscript_hf_roles';
const P_FORMS   = 'custscript_hf_forms';
const P_BODY    = 'custscript_hf_body';
const P_SUBLSTS = 'custscript_hf_sublists';
const P_SUBFLDS = 'custscript_hf_subflds';

const DEFAULT_SUBLISTS = ['item', 'expense', 'line', 'apply', 'credit', 'payment', 'billing'];

const parseCsv = (val) =>
String(val || '')
.split(',')
.map(s => s.trim())
.filter(Boolean);

const parseCsvNums = (val) =>
parseCsv(val)
.map(v => Number(v))
.filter(n => Number.isFinite(n));

const beforeLoad = (context) => {
// UI only
const allowedTypes = [context.UserEventType.CREATE, context.UserEventType.EDIT, context.UserEventType.VIEW];
if (!allowedTypes.includes(context.type)) return;

const script = runtime.getCurrentScript();

// Role filter (optional)
const allowedRoles = parseCsvNums(script.getParameter({ name: P_ROLES }));
if (allowedRoles.length) {
const currentRole = Number(runtime.getCurrentUser().role);
if (!allowedRoles.includes(currentRole)) return;
}

// Form filter (optional) - transactions typically use "customform"
const allowedForms = parseCsvNums(script.getParameter({ name: P_FORMS }));
if (allowedForms.length) {
const formId = Number(context.newRecord.getValue({ fieldId: 'customform' }));
if (!allowedForms.includes(formId)) return;
}

const form = context.form;

// Hide body fields
const bodyFieldIds = parseCsv(script.getParameter({ name: P_BODY }));
bodyFieldIds.forEach((fieldId) => {
try {
const fld = form.getField({ id: fieldId });
if (fld) fld.updateDisplayType({ displayType: 'HIDDEN' });
} catch (e) {
// ignore
}
});

// Hide sublist columns
const sublistFieldIds = parseCsv(script.getParameter({ name: P_SUBFLDS }));
if (!sublistFieldIds.length) return;

const configuredSublists = parseCsv(script.getParameter({ name: P_SUBLSTS }));
const sublistsToCheck = configuredSublists.length ? configuredSublists : DEFAULT_SUBLISTS;

sublistsToCheck.forEach((sublistId) => {
let sublist;
try {
sublist = form.getSublist({ id: sublistId });
} catch (e) {
return;
}
if (!sublist) return;

sublistFieldIds.forEach((fieldId) => {
try {
const fld = sublist.getField({ id: fieldId });
if (fld) fld.updateDisplayType({ displayType: 'HIDDEN' });
} catch (e) {
// ignore
}
});
});
};

return { beforeLoad };
}); 

            

To create the script record:

1. Upload your script to the NetSuite File Cabinet.

2. Go to Customization > Scripting > Scripts > New.

3. Select User Event Script and then select the uploaded script file.

4. Open the Parameters tab and add the following parameters:

   Parameter	Label	ID	Type	Description/ Help
   Allowed Role IDs (optional)	Role IDs	custscript_hf_roles	Free-form text	List of role internal IDs, for example 1019,1050. Blank = all roles.
   Allowed Form IDs (optional)	Transaction Form IDs	custscript_hf_forms	Free-form text	List of transaction form internal IDs, for example 123,456. Blank = all forms.
   Body Field IDs to hide (optional)	Body Field IDs to hide	custscript_hf_body	Free-form text	List of body field IDs, for example memo,custbody_myfield.
   Sublist IDs to target (optional)	Sublist IDs to target	custscript_hf_sublists	Free-form text	List of sublist IDs, for example item,expense. Blank = script uses defaults.
   Sublist Field IDs to hide (optional)	Column Field IDs to hide	custscript_hf_subflds	Free-form text	List of sublist field IDs, for example taxdetailsreference,custcol_mycol.

To deploy the script:

1. On the script record, click Deploy Script.

2. Set the deployment values:

   Field	Value
   Status	"Testing" (initially), then "Released" when validated
   Applies To (Record Type)	Transaction type, for example "Vendor Bill", "Invoice", "Sales Order"
   Execute As Role	"Default" (if you don't have a reason to change this value)
   Event Behavior	Script runs in beforeLoad. Deployment must be active.

3. Click Save.

4. Open the deployment record and set the parameters as needed.

Example Deployment Values

• custscript_hf_roles = "1019"

• custscript_hf_forms = "123"

• custscript_hf_body = (leave blank if none)

• custscript_hf_sublists = "item,expense"

• custscript_hf_subflds = "taxdetailsreference"

To test your solution:

1. Set the Deployment Status field to "Testing".

2. Log in as a user with the target role.

3. Open a transaction using the target form.

4. Verify the configured body fields are hidden.

5. Verify the configured sublist columns are hidden.

6. Confirm the script doesn't affect other forms or roles when restricted.

7. Set Deployment Status field to "Released" when confirmed.