How to Manage NetSuite SuiteTalk Field Visibility on Custom Forms

Fields must be present on the form used by the web services call to allow values to be set. There are two primary approaches to address this:

1. Specify an Alternate Form: When making a SuiteTalk web services call, explicitly specify a custom form where the required field is present and visible. This ensures the field is available for interaction.

2. Use a User Event Script: For scenarios where a field needs to be dynamically made visible or editable, especially for web service contexts, a User Event script (SuiteScript 2.x) can be deployed. This script will adjust the field's display type during the beforeLoad event.

   It is important to note that while form display properties can be manipulated in beforeLoad for both new and existing records, direct data manipulation (setting field values) for *existing* records is generally not possible within the beforeLoad context in SuiteScript 2.x. However, making a field visible allows subsequent operations (e.g., in beforeSubmit or afterSubmit, or by the web service itself) to interact with it.

   Below is an example of a SuiteScript 2.x User Event script that makes a specified field visible when the execution context is webservices:

javascript
/**
 * @NApiVersion 2.x
 * @NScriptType UserEventScript
 */
define(['N/runtime', 'N/ui/serverWidget'], function(runtime, serverWidget) {

    function beforeLoad(context) {
        if (context.type === context.UserEventType.CREATE || context.type === context.UserEventType.EDIT) {
            if (runtime.executionContext === runtime.ContextType.WEBSERVICES) {
                var form = context.form;
                var field = form.getField({ id: 'field_id' }); // Replace 'field_id' with the actual field ID

                if (field) {
                    field.updateDisplayType({
                        displayType: serverWidget.FieldDisplayType.NORMAL
                    });
                }
            }
        }
    }

    return {
        beforeLoad: beforeLoad
    };
});

In this script:

• N/runtime and N/ui/serverWidget modules are loaded for context and form manipulation.
• The beforeLoad function is triggered before a record is loaded.
• runtime.executionContext === runtime.ContextType.WEBSERVICES checks if the script is running due to a web services call.
• form.getField({ id: 'field_id' }) retrieves the field object.
• field.updateDisplayType({ displayType: serverWidget.FieldDisplayType.NORMAL }) sets the field's display type to normal, making it visible and editable.
• The context.type check (CREATE or EDIT) is added for robustness, as beforeLoad can also fire for VIEW events where display changes might not be relevant for web services.